Cancel a scheduled email
Cancel a still-queued send. Only a queued message is cancellable; a canceled send is never sent and never billed.
POST
Cancel a still-queued send. Only a queued message is cancellable; a canceled send is never sent and never billed. Cancel is idempotent — an already-canceled message returns 200 again. Any other status returns 409. Requires the send scope. Takes no request body.
Loading code example
Loading code example
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
idstringrequired
The message id (a bare 26-character ULID, no prefix).
Response
application/json
The canceled email detail.
object"email"requiredAllowed values:
"email"idstringrequiredtoarray<string>requiredfromstringrequiredcreated_atstring<date-time>requiredsubjectstringhtmlstringtextstringccarray<string>requiredbccarray<string>requiredreply_toarray<string>requiredlast_eventstringrequiredscheduled_atstring<date-time>tagsarray<object>requiredtags.namestringrequiredTag name; must match `[A-Za-z0-9_-]+`.
tags.valuestringrequiredTag value; must match `[A-Za-z0-9_-]+`.