POST
/
v1
/
transactional
/
send
{}

Authorizations

Authorization
string
header
required

Workspace-scoped API key from the credentials table

Body

application/json
email
string<email>
required
templateId
string
required

Workspace-unique template slug ID returned by the transactional template list endpoint

locale
string

Optional locale tag such as en, en-us, or fr-ca used to select localized template content before rendering

dataVariables
object
addToAudience
boolean

Accepted by the current handler but not acted on by the send path today

addToContact
boolean
default:false

When true, best-effort create or update the recipient as a contact and link the outbound recipient row without changing marketing consent

firstName
string | null

Optional contact first name used only when addToContact is true

lastName
string | null

Optional contact last name used only when addToContact is true

externalId
string | null

Optional external contact identifier mapped to the contact userId field when addToContact is true

properties
object
traits
object

Optional alias of properties used only when addToContact is true; properties wins on key collisions

attachments
object[]
Maximum array length: 3

Response

Transactional message accepted

success
enum<boolean>
required
Available options:
true