On this page

Retrieve scheduled send

API Overview

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.

Operation overview

GET/v3/user/scheduled_sends/{batch_id}

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 the cancel/paused scheduled send information for a specific batch_id.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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.

Path parameters

Property nameTypeRequiredDescription

batch_idstringrequired

Responses

200400401403404500

SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties

batch_idstring

Pattern: ^[a-zA-Z0-9\-\_]

statusenum<string>

The status of the scheduled send.

Possible values:

cancelpause

Retrieve scheduled send

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const batch_id = "ZGkrHSypTsudrGkmdpJJ";
5
6const request = {
7  url: `/v3/user/scheduled_sends/${batch_id}`,
8  method: 'GET',
9  
10}
11
12client.request(request)
13  .then(([response, body]) => {
14    console.log(response.statusCode);
15    console.log(response.body);
16  })
17  .catch(error => {
18    console.error(error);
19  });