Skip to content

Cancel a scheduled delivery

DELETE
/mail/mailboxes/{mailbox}/scheduled/{scheduledDraft}
curl --request DELETE \
--url https://mail.work.optidata.cloud/api/mail/mailboxes/78/scheduled/44 \
--header 'Authorization: Bearer <token>'

Call off a pending delivery. The draft itself survives and returns to the Drafts folder.

Requires scheduled sending to be enabled for the tenant.

mailbox
required
integer

Id of the mailbox. Every mailbox the caller may use is listed in their account.

scheduledDraft
required
integer

Id of the scheduled delivery.

The delivery was cancelled.

Media typeapplication/json

Acknowledgement returned by several write operations.

object
message
required
string
Examples
Examplecancelled
{
"message": "Scheduled draft cancelled."
}

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
"error": "JWT passport exception: Missing bearer token in request"
}

Scheduled sending is not enabled for this tenant.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledisabled
{
"message": "Not available"
}

No such resource, or it does not belong to the caller.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplemissing
{
"message": "No query results for model."
}

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
"message": "Too Many Attempts."
}