Skip to content

Reference / Messages

Get message

GET/api/v1/messages/{id}

A message and how it went: sent, delivered, bounced …

Guide: messages from Qrona →

Scope

  • messages:send Send 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.
templatestringrequired
template_versionintegerrequired
The template version the message was made from. Published versions never change.
html_sha256stringrequired
SHA-256 of the HTML the recipient got.
categorystringrequired
servicemarketing
referencestringrequired
client_refstringrequired
created_atstring (time, ISO 8601)required
When the message was received.

Errors