Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve all scheduled sends

API Overview

api-overview page anchor

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:

  • Define and validate the ID for a batch of messages.
  • Retrieve, update, pause, resume, or cancel a scheduled send.

Cancelling or pausing a batch of messages include the following conditions:

  • You can't pause or cancel more than 10 different batches at one time.
  • You can't pause or cancel a batch later than 10 minutes before the scheduled send_at time.
  • When you cancel or pause a batch, all messages associated with that batch stay in your sending queue.
  • When a cancelled batch reaches its send_at time, SendGrid discards the messages.
  • When a paused batch reaches its send_at time, SendGrid retains the messages. When you resume a paused batch, SendGrid delivers your scheduled send.
  • When a paused batch passes 72 hours after its send_at time, SendGrid discards the messages as Expired.

To cancel a scheduled send of a single message, consult Canceling a Scheduled Send.

Operation overview

operation-overview page anchor

GET/v3/user/scheduled_sends

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

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.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstring

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.

Responses

responses page anchor
200400401403404500
SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties
batch_idstring

Optional

Pattern: ^[a-zA-Z0-9\-\_]
statusenum<string>

Optional

The status of the scheduled send.

Possible values:
cancelpause
Retrieve all scheduled sendsLink to code sample: Retrieve all scheduled sends
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const request = {

5
  url: `/v3/user/scheduled_sends`,

6
  method: "GET",

7
};

8


9
client

10
  .request(request)

11
  .then(([response, body]) => {

12
    console.log(response.statusCode);

13
    console.log(response.body);

14
  })

15
  .catch((error) => {

16
    console.error(error);

17
  });