Get message
GET/api/v1/messages/{id}
A message and how it went: sent, delivered, bounced …
Scope
messages:sendSend messages – the person behind the key must be all members.
Path parameters
idstringrequired- The message's id.
Response
200 The message.
message_idstringrequired- The message's id.
statusstringrequired- queued: waiting for another attempt · sent: handed to the sending service · delivered: delivered · bounced: bounced · complained: spam complaint · failed: could not be delivered · suppressed: not sent, see reason.
queuedsendingsentdeliveredbouncedcomplainedfailedsuppressed reasonstring | nullrequired- Why a message was not sent: bounced, complained, manual, erased, unsubscribed (marketing only), service_limit, monthly_cap or payment.
templatestringrequiredtemplate_versionintegerrequired- The template version the message was made from. Published versions never change.
html_sha256stringrequired- SHA-256 of the HTML the recipient got.
categorystringrequiredservicemarketingreferencestringrequiredclient_refstringrequiredcreated_atstring (time, ISO 8601)required- When the message was received.
Errors
- 404
- not_found
- 429
- rate_limited