API reference
Messages
/messages
Messages are produced by rules when you post events. They are read only: there is no messages:write and no way to send one directly.
GET/messagesList · ?q ?contact_id ?subject_id ?status ?channelGET/messages/{message_id}ReadGET/messages/{message_id}/emailRead the email as it wentshown →
GETRead an email as it went
Requires messages:read. For a message whose channel is email: the subject, the HTML and the plain text, rendered from the design revision and the values stored on the message. The shape and the values replay exactly; wording edited since shows its new words.
Path parameters
message_iduuid · required
The message id.
Returns
200 with subject, html and text. 404 not_found when there is no such message, when it went by SMS or WhatsApp, or when its design can no longer be read.
Response body
One email as sent: the same fields in every pack. Press Response on the sample to see one whole.
FieldTypeDescription
subjectstringAs it went.
htmlstringThe whole HTML document: the instance's design, with the wording inside it.
textstringThe plain-text part sent beside it.
On failure the body is { error, code } instead.