Skip to contentSkip to navigationSkip to topbar
On this page

Schedule Single Send



API Overview

api-overview page anchor

A Single Send is a one-time, non-automated email message delivered to a list or segment of your audience. A Single Send may be sent immediately or scheduled for future delivery.

Single Sends can serve many use cases, including promotional offers, engagement campaigns, newsletters, announcements, legal notices, or policy updates.

The Single Sends API allows you to create, retrieve, update, delete, schedule, and deliver your Single Sends. There are also endpoints for searching and statistics to help you maintain and alter your Single Sends as you learn more and further develop your campaigns.

The Single Sends API changed on May 6, 2020. Please check the SendGrid Knowledge Center for updates and instructions here: https://sendgrid.com/docs/for-developers/sending-email/single-sends-2020-update/


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

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

This endpoint allows you to send a Single Send immediately or schedule it to be sent at a later time.

To send your message immediately, set the send_at property value to the string now. To schedule the Single Send for future delivery, set the send_at value to your desired send time in ISO 8601 date time format(link takes you to an external page) (yyyy-MM-ddTHH:mm:ssZ).


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
idstringrequired
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
send_atstring<date-time>required

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.

201404500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
send_atstring<date-time>

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>
Possible values:
scheduled
Schedule Single SendLink to code sample: Schedule Single Send
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const id = "ZGkrHSypTsudrGkmdpJJ";
5
const data = {
6
send_at: "3752-01-28T23:21:52.575Z",
7
};
8
9
const request = {
10
url: `/v3/marketing/singlesends/${id}/schedule`,
11
method: "PUT",
12
body: data,
13
};
14
15
client
16
.request(request)
17
.then(([response, body]) => {
18
console.log(response.statusCode);
19
console.log(response.body);
20
})
21
.catch((error) => {
22
console.error(error);
23
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.