Skip to main content
POST
Send a transactional email

Authorizations

Authorization
string
header
required

API key for account management endpoints. Use your api_ prefixed token.

Body

application/json
transactionalId
string
required

Template id to send

email
string
required

Recipient

Example:

"jane@example.com"

dataVariables
object

Merge values for {{firstName}}, {{resetUrl}}, custom fields, …

Example:
subject
string

Overrides the template subject

fromName
string

Overrides the template sender name

fromEmail
string

Overrides the template from address. Defaults to the template sender if omitted. Must be on a verified sending domain.

replyTo
string

Overrides the template reply-to

addToAudience
boolean

Upsert the recipient as a contact

audienceIds
string[]

Audiences to add the contact to (with addToAudience)

attachments
object[]

Optional file attachments, 25 MB total. Same shape as /email: filename plus base64-encoded data.

Response

Sent

success
boolean
id
string

Send id

messageId
string