Using the Cancel Scheduled Sends API, you can cancel or pause sending one or more groups of emails. SendGrid defines these multiple scheduled send requests together as batches identified with a batch_id
.
With this API, you can perform the following tasks on scheduled emails:
Cancelling or pausing a batch of messages include the following conditions:
send_at
time.send_at
time, SendGrid discards the messages.send_at
time, SendGrid retains the messages.
When you resume a paused batch, SendGrid delivers your scheduled send.send_at
time, SendGrid discards the messages as Expired.To cancel a scheduled send of a single message, consult Canceling a Scheduled Send.
This endpoint allows you to retrieve all cancelled and paused scheduled send information.
This endpoint will return only the scheduled sends that are associated with a batch_id
. If you have scheduled a send using the /mail/send
endpoint and the send_at
field but no batch_id
, the send will be scheduled for delivery; however, it will not be returned by this endpoint. For this reason, you should assign a batch_id
to any scheduled send you may need to pause or cancel in the future.
Bearer <<YOUR_API_KEY_HERE>>
Optional
The on-behalf-of
header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>
). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>
). See On Behalf Of for more information.
Array of:
Optional
^[a-zA-Z0-9\-\_]
Optional
The status of the scheduled send.
cancel
pause
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const request = {5url: `/v3/user/scheduled_sends`,6method: "GET",7};89client10.request(request)11.then(([response, body]) => {12console.log(response.statusCode);13console.log(response.body);14})15.catch((error) => {16console.error(error);17});