Transactional — Message¶
A transactional message is a prepared, parameterizable message sent to a single contact.
Messages may use standard merge codes, plus Transactional:[argument_name] codes where
argument_name is a freeform single word fed from arguments passed to
/transactional/message/send/.
Endpoints¶
| Method | URL |
|---|---|
GET |
/transactional/<transactional>/message/<transactionalmessage> |
POST |
/transactional/<transactional>/message |
PUT |
/transactional/<transactional>/message/<transactionalmessage> |
DELETE |
/transactional/<transactional>/message/<transactionalmessage> |
GET /transactional/<transactional>/message/<transactionalmessage>¶
Payload: No payload.
Returns: The message.
POST /transactional/<transactional>/message¶
| Parameter | Type | Description |
|---|---|---|
name |
string | Message name |
event_callback |
string | Optional. URL called back when events occur. |
Returns: The new message.
PUT /transactional/<transactional>/message/<transactionalmessage>¶
Same payload as POST.
Returns: The edited message.
DELETE /transactional/<transactional>/message/<transactionalmessage>¶
Payload: No payload.
Returns: The deleted message.
Callback Behaviour¶
Same callback behaviour as Campaign.