Render a template - Application Level Templates - API Reference

POST

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

Renders the specified application-level template with the provided variables.

Works with an API key or an IAM API key with the templates.render permission.

Parameters

Path parameters

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

curl --request POST \ --url "https://api.us.nylas.com/v3/templates/<TEMPLATE_ID>/render" \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json' \ --data '{ "variables": { "user": { "name": "Nylas", "surname": "Tester" } } }'