POST/api/v1/messages

Send a transactional message

Sends a one-off transactional email. Provide sender_id and type, and choose a recipient using contact_id, external_contact_id, or recipient_email; the message content must come from a template or the request body. A matching project contact is linked to the message when you use recipient_email.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

Transactional message parameters supplied under data; include the required sender_id and type.

dataobjectoptional

1 status code
200Returns the sent message, including its identifier, recipient email address, and subject.
dataobjectoptional

Error handling

The request requires sender_id and type. Provide a recipient using contact_id, external_contact_id, or recipient_email, and provide message content through template_id or a body field appropriate to type.