POST /api/template-render
Render a template with the given template ID and context attribute. Returns the AMP, 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 acontext
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
Servers
- https://a.klaviyo.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
revision |
String | Yes |
API endpoint revision (format: YYYY-MM-DD[.suffix]) Default value: "2025-04-15" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.