The Cancel Scheduled Sends API allows you to cancel or pause the send of one or more emails using a batch ID.
A batch_id
groups multiple scheduled mail/send
requests together with the same ID. You can cancel or pause all of the mail/send
requests associated with a batch ID up to 10 minutes before the scheduled send time by passing a batch_id
to the "Cancel or pause a scheduled send" endpoint.
For a guide on creating a batch_id
, assigning it to a scheduled send, and modifying the send, see "Canceling a Scheduled Send".
The Cancel Scheduled Sends API also make it possible to validate a batch_id
and retrieve all scheduled sends as an array.
When a batch is canceled, all messages associated with that batch will stay in your sending queue. When their send_at
value is reached, they will be discarded.
When a batch is paused, all messages associated with that batch will stay in your sending queue, even after their send_at
value has passed. This means you can remove a pause
status, and your scheduled send will be delivered once the pause is removed. Any messages left with a pause
status that are more than 72 hours old will be discarded as Expired.