Transactional emails

Send a transactional email

Send a transactional email to a contact.<br>Please email us to enable attachments on your account before using them with the API.

post/v1/transactional

Headers

Idempotency-Keystring

Include a unique ID for this request (maximum 100 characters) to avoid duplicate emails. More info

Request body

emailstring required
transactionalIdstring required

The ID of the transactional email to send.

addToAudienceboolean

If true, a contact will be created in your audience using the email value (if a matching contact doesn't already exist).

dataVariablesobject

An object containing contact data as defined by the data variables added to the transactional email template.

Example request

{
  "dataVariables": {
    "name": "Chris",
    "passwordResetLink": "https://example.com/reset-password"
  }
}

Response

Successful send.

successboolean required

Example response

{
  "success": true
}

Changes