Cancel scheduled sends
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.
Validate batch ID
GET /v3/mail/batch/{batch_id}
Base url: https://api.sendgrid.com
This endpoint allows you to validate a batch ID.
When you pass a valid batch_id
to this endpoint, it will return a 200
status code and the batch ID itself.
If you pass an invalid batch_id
to the endpoint, you will receive a 400
level status code and an error message.
A batch_id
does not need to be assigned to a scheduled send to be considered valid. A successful response means only that the batch_id
has been created, but it does not indicate that it has been associated with a send.
Authentication
- API Key
Headers
Path Parameters
Responses
{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}
Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.