Render template as HTML - Grant Level Templates - API Reference

POST

https://api.us.nylas.com/v3/grants/{grant_id}/templates/render

Renders the HTML content of a grant-level template using the provided variables and specified templating engine.

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.create 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.

Example: "[email protected]"

Request body

body*string

The body content of the template, in HTML format.

Example: "<p>Hello {{user.name}}, this shows test was {{ foo }}.</p>"

engine*string

The templating engine to use.

handlebarsmustache

Example: "mustache"

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"},"foo":"testing successful"}

Responses

request_id*string

The ID of the request.

Example: "3907012912-13b5a9a4-f136-4761-a31b-68c6a8af825d"

data*object

curl --request POST \ --url "https://api.us.nylas.com/v3/grants/<NYLAS_GRANT_ID>/templates/render" \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json' \ --data '{ "body": "<p>Hello from {{user.name}}, test {{ foo }}</p>", "variables": { "user": { "name": "Nylas", "surname": "Tester" }, "foo": "hi" }, "engine": "mustache" }'