Skip to content
Skip to main content
POST
https://api.us.nylas.com/v3/grants/{grant_id}/templates/{template_id}/render

Render a template

Renders the specified template with the provided variables. Nylas looks for a grant-level template with this ID first. If the grant doesn't have one, it renders the application-level template with the same ID.

Works with an API key, an access token (use /v3/grants/me/ in place of the grant ID), or an IAM API key with the templates.render permission.

Parameters

Path parameters

grant_id*string

ID of the grant to access. You can also use the email address associated with the grant, or use /me/ to refer to the grant associated with an access token.

template_id*string

The ID of the template to access.

Example: "14c00cc8-648c-4381-ad10-52641d9bac8e"

Request body

strictboolean

When true, Nylas returns an error if the template contains variables that aren't defined in the variables object.

Default: true
Example: true
variables*object

A set of key/value pairs representing variables to substitute for values in the template.

Example: {"user":{"name":"Leyah","surname":"Miller"}}

Responses

request_id*string

The ID of the request.

Example: "3822450015-47d9207c-4d06-4e15-b3e7-752c5dd5585d"
data*object
POSThttps://api.us.nylas.com/v3/grants/nyla%40example.com/templates/14c00cc8-648c-4381-ad10-52641d9bac8e/render

Find your API key in the Nylas Dashboard under API Keys in your application settings.

grant_idrequiredstring

ID of the grant to access. You can also use the email address associated with the grant, or use /me/ to refer to the grant associated with an access token.

template_idrequiredstring

The ID of the template to access.

Loading editor...

Autocomplete and validation come from this endpoint's request schema.