TRtrycourier
Messages

Cancel message

Changed on

Cancels a message that is still in the delivery pipeline and returns the message record with its resulting canceled or failed status.

post/messages/{message_id}/cancel

Request

Path parameters

message_idstring required

A unique identifier representing the message ID

Response

idstring required

A unique identifier associated with the message you wish to retrieve (results from a send).

status'CANCELED' | 'CLICKED' | 'DELAYED' | 'DELIVERED' | 'DIGESTED' | 'ENQUEUED' | 'FILTERED' | 'OPENED' | 'ROUTED' | 'SENT' | 'SIMULATED' | 'THROTTLED' | 'UNDELIVERABLE' | 'UNMAPPED' | 'UNROUTABLE' required
enqueuedinteger required

A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.

sentinteger

A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.

deliveredinteger

A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.

openedinteger

A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.

clickedinteger

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.

recipientstring required

A unique identifier associated with the recipient of the delivered message.

eventstring required

A unique identifier associated with the event of the delivered message.

notificationstring required

A unique identifier associated with the notification of the delivered message.

errorstring nullable

A message describing the error that occurred.

reason'BOUNCED' | 'FAILED' | 'FILTERED' | 'NO_CHANNELS' | 'NO_PROVIDERS' | 'OPT_IN_REQUIRED' | 'PROVIDER_ERROR' | 'UNPUBLISHED' | 'UNSUBSCRIBED'

Changes

  • f76bed79a913Revision changes
    • info

      api tag Messages added

    • info

      api tag Sent Messages removed

  • 19330fca8fa9Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status