HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for v2022-10-17. Click to read the latest docs for v2024-10-15.

Create Template Render

Render a template with the given template ID and context attribute. Returns the HTML and plain text versions of the email template.

Request body parameters (nested under attributes):

  • return_fields: Request specific fields using sparse fieldsets.
  • context: This is the context your email template will be rendered with. You must pass in a context object as a JSON object.

Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding context values are treated as FALSE and output nothing.

Ex. { "name" : "George Washington", "state" : "VA" }

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes:
Templates Read

Language
Credentials
Header