POST/emails/{email_id}/cancel

Cancel a scheduled email

Cancels the scheduled send of an email. Use email_id to identify the email whose scheduled delivery you want to cancel; the response includes the email's current details and latest event.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
email_idstringrequired
The ID of the email whose scheduled send to cancel.

1 status code
200Returns the email's details, including its identifiers, recipients, message content, and latest event.
objectstringoptional
The type of object.
idstringoptional
The ID of the email.
message_idstringoptional
The Message-ID header value of the email.
toarray<string>optional
fromstringoptional
The email address of the sender.
created_atstringoptional
The date and time the email was created.
subjectstringoptional
The subject line of the email.
htmlstringoptional
The HTML body of the email.
textstringoptional
The plain text body of the email.
bccarray<string>optional
The email addresses of the blind carbon copy recipients.
ccarray<string>optional
The email addresses of the carbon copy recipients.
reply_toarray<string>optional
The email addresses to which replies should be sent.
last_eventstringoptional
The status of the email.
Allowed:bouncedcanceledclickedcomplaineddelivereddelivery_delayedfailedopenedqueuedscheduledsentsuppressed

Error handling

The email_id path parameter must identify an email.