Cancel a scheduled email

DELETE/api/v1/mailbox/messages/scheduled/{message_id}
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Stops it from being sent and moves it to Drafts, where it can be edited and sent again.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.
404 That message is not scheduled (it may already have gone).

Parameters

NameInTypeDescription
message_idrequiredpathstring

Request

DELETE/api/v1/mailbox/messages/scheduled/{message_id}
curl -X DELETE 'https://courier.mailyte.com/api/v1/mailbox/messages/scheduled/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataobject
    • idstring

      Its id in Drafts.

    • folderstring
200application/json
{
  "type": "success",
  "msg": "Send cancelled. The message is in Drafts.",
  "data": {
    "id": "Drafts:32",
    "folder": "Drafts"
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.
404`That message is not scheduled` (it may already have gone).
422Validation Error

Every status, with what causes it and what to do, is on the error reference.