Transactional messages are one-off email or push sends to one recipient, such as receipts and password resets, that a person needs whatever their marketing choices. Transactional email ignores marketing consent and topics, but not a bounce or a transactional spam complaint. Transactional push still needs the contact's push consent and an eligible device. A send returns 202 when accepted, not when delivered: read each message in the message log (GET /v1/messages/{id}) for what happened. See Transactional messages.
Endpoints
| Endpoint | Request |
|---|---|
| Send a transactional message | POST /v1/transactional/messages |
| Send transactional messages in a batch | POST /v1/transactional/messages/batch |
| Cancel a scheduled transactional message | POST /v1/transactional/messages/{id}/cancel |
The TransactionalMessage object
{
"id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
"channel": "email",
"status": "queued",
"correlationId": "018f2a4e-6b1c-7d3e-9f40-52d087625a6b",
"createdAt": "2030-03-14T09:30:00Z",
"sendAt": "2030-03-14T09:30:00Z",
"fallbackFor": "018f2a4e-6b1c-7d3e-9f40-ea216e3e5a6b",
"copy": {
"kind": "cc",
"of": "018f2a4e-6b1c-7d3e-9f40-69343c685a6b"
}
}idstringrequireduuid
channelstringrequiredone of
email,pushstatusstringrequiredone of
queued,sending,skipped,sent,failed,delivered,bounced,complainedcorrelationIdstring | nullrequiredThe
correlationIdgiven when it was sent, if any.createdAtstringrequireddate-time
sendAtstring | nullrequiredWhen a timed message goes out; null when it went at once.
date-time
fallbackForstring | nullrequiredWith
fallbackOrder: the message this one stands in for. It waits asqueueduntil that one ends: sent when it failed, was skipped or bounced, else skipped with reasonfallback_not_needed. Null otherwise.uuid
copyobject | nullrequiredSet on a
ccorbcccopy; null on the message itself.2 child attributes
kindstringrequiredone of
cc,bccofstringrequiredThe message it is a copy of.
uuid