Delete Single Send Schedule

API Overview

Twilio calls a one-time, non-automated email message delivered to a list or segment of your audience a Single Send. You can send such messages immediately or scheduled for future delivery. Single Sends can deliver promotional offers, engagement campaigns, newsletters, announcements, legal notices, or policy updates. The Single Sends API lets you create, retrieve, update, delete, schedule, and search for Single Sends. Another API endpoint provides campaign statistics. The SendGrid Knowledge Center explains the latest updates to the Single Sends API.

Operation overview

DELETE/v3/marketing/singlesends/{id}/schedule

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint allows you to cancel a scheduled Single Send using a Single Send ID.

Making a DELETE request to this endpoint will cancel the scheduled sending of a Single Send. The request will not delete the Single Send itself. Deleting a Single Send can be done by passing a DELETE request to /marketing/singlesends/{id}.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

idstring

required

Responses

200404500

Schema

Property nameTypeRequiredDescriptionChild properties

send_atstring<date-time>

Optional

The ISO 8601 time at which to send the Single Send. This must be in future or the string now. SendGrid Mail Send emails can be scheduled up to 72 hours in advance. However, this scheduling constraint does not apply to emails sent via Marketing Campaigns.

statusenum<string>

Optional

Possible values:

draftscheduledtriggered

Delete Single Send Schedule

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const id = "id";
5
6const request = {
7  url: `/v3/marketing/singlesends/${id}/schedule`,
8  method: "DELETE",
9};
10
11client
12  .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  });