Transactional Message — Send¶
Send a transactional message to one or more recipients.
Endpoint¶
| Method | URL |
|---|---|
POST |
/transactional/<transactional>/message/<transactionalmessage>/send |
POST¶
| Parameter | Type | Description |
|---|---|---|
event_callback |
string | Optional. Callback URL for lifecycle events. |
email[] |
string array | Optional. List of email addresses to send to. |
telephone[] |
string array | Optional. Telephone numbers to send SMS to. |
attachment[] |
object array | Optional. Attachments for email. See structure below. |
<custom_field>[] |
string array | Optional. Arguments for %Transactional:[argument_name]% placeholders. |
Note
Either telephone[] or email[] (or both) must be defined.
Sending to multiple recipients¶
Pass array parameters by repeating the argument:
When sending to both email and SMS simultaneously, same-index entries in email[] and
telephone[] are treated as the same contact. Use an empty string for contacts that
have one channel but not the other.
email[], telephone[], attachment[], and custom field parameters must all be the same length.
Attachment structure¶
| Key | Description |
|---|---|
filename |
Name of the file |
content-type |
MIME type |
base64 |
Base64-encoded attachment data |
Tip
For large payloads (especially with attachments), send as JSON:
set Content-Type: application/json and submit as a JSON dictionary.
Returns: Array of API success envelopes, one per submitted contact.
Callback Behaviour¶
Same callback behaviour as Campaign.