Create Template Render

POST {{baseUrl}}/api/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

Request Body

{"data"=>{"type"=>"template", "id"=>"<string>"}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring
Acceptstring

RESPONSES

status: Created

{&quot;data&quot;:{&quot;type&quot;:&quot;template&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;editor_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;html&quot;:&quot;\u003cstring\u003e&quot;,&quot;text&quot;:&quot;\u003cstring\u003e&quot;,&quot;created&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;}}}