Render and Send Template

post https://a.klaviyo.com/api/v1/email-template/{template_id}/send

Renders the specified template with the provided data and send the contents in an email via the service specified. This API is intended to test templates only, and is rate limited to the following thresholds: 100/hour, 1,000/day.

🚧
Deprecation Notice
This endpoint is being deprecated and we are no longer verifying accounts for this functionality. To achieve similar functionality, create a metric-triggered flow, then send one or more Track API calls.

Path Params

template_id

string

required

Defaults to TEMPLATE_ID

Form Data

from_email

string

required

Defaults to george.washington@klaviyo.com

from_name

string

required

Defaults to George Washington

subject

string

required

Defaults to Happy Fourth!

blob

required

Defaults to [{"name":"Abraham Lincoln","email":"abraham.lincoln@klaviyo.com"}]

Mixed. string, or JSON encoded array of objects with "email" and "name" keys.
abraham.lincoln@klaviyo.com
OR
[{"name":"Abraham Lincoln","email":"abraham.lincoln@klaviyo.com"}]

context

blob

Defaults to { "name" : "George Washington", "state" : "VA" }

Optional, JSON object.
This is the context your email template will be rendered with. Email templates are rendered with contexts in a similar manner to how Django templates are rendered. This means that nested template variables can be referenced via dot notation and template variables without corresponding context values are treated as falsy and output nothing.
ex: { "name" : "George Washington", "state" : "VA" }

Response

Language

Credentials

Query


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://a.klaviyo.com/api/v1/email-template/TEMPLATE_ID/send?api_key=PRIVATE_API_KEY' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded' \
5
     --data from_email=george.washington@klaviyo.com \
6
     --data 'from_name=George Washington' \
7
     --data 'subject=Happy Fourth!' \
8
     --data 'to=[{"name":"Abraham Lincoln","email":"abraham.lincoln@klaviyo.com"}]' \
9
     --data 'context={ "name" : "George Washington", "state" : "VA" }'


xxxxxxxxxx
 
1
{
2
  "object": "email-template",
3
  "id": "TEMPLATE_ID",
4
  "name": "TEMPLATE_NAME",
5
  "data": {
6
    "html": "<html><body><p>This is an email for {{ email }}.</p></body></html>",
7
    "text": "This is an email for george.washington@klaviyo.com"
8
  }
9
}

🚧Deprecation Notice

200The Email Template object with an additional data property that contains the status of the message. If successful, the status will be queued.

🚧
Deprecation Notice