Messages

Cancel a scheduled message

Requires scope: manage or inbox (inbox only in a signed-in dashboard session; no API key or app can hold it). Cancels a send that is still scheduled, so it is never sent. Once the send starts going out it can no longer be canceled: the cancel changes nothing and answers 409 duplicate_resource, also when the send started while the cancel was running. A test key cannot cancel a send a live key scheduled (403 live_mode_required).

post/v1/messages/{id}/cancel

Request

  • Base URL: https://api.mails.ai
  • URL: https://api.mails.ai/v1/messages/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Sent message id with status scheduled.

Response

The canceled message.

idstring required

Id of the canceled message (msg_…): the id in the path.

status'canceled' required

Always canceled: the message will not be sent. Only a scheduled message can be canceled.

canceled_atstring date-time required

When the send was canceled: the time of this request, also kept as the message's canceled_at.

Changes

No recorded changes to this operation across all 1 revision of this API.