Cancel message
Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either 200 status code for a successful cancellation or 409 status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A unique identifier representing the message ID
Response
A unique identifier associated with the message you wish to retrieve (results from a send).
The current status of the message.
CLICKED, DELIVERED, ENQUEUED, OPENED, CANCELED, SENT, THROTTLED, UNDELIVERABLE, UNMAPPED, UNROUTABLE A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.
A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.
A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.
A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.
A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.
A unique identifier associated with the recipient of the delivered message.
A unique identifier associated with the event of the delivered message.
A unique identifier associated with the notification of the delivered message.
A message describing the error that occurred.
The reason for the current status of the message.
FILTERED, NO_CHANNELS, NO_PROVIDERS, PROVIDER_ERROR, UNPUBLISHED, UNSUBSCRIBED