Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Schedule a Campaign



API Overview

api-overview page anchor
(warning)

Legacy Marketing Campaigns

You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns

(information)

Info

For the most up-to-date information on the Sender Identities API, please visit the new Marketing Campaigns Single Sends API.

The Campaigns API allows you to create and manage marketing campaigns. You can create campaigns, manage campaign content, and schedule campaigns to be sent at a later time.


POST/v3/campaigns/{campaign_id}/schedules

Base url: https://api.sendgrid.com

This endpoint allows you to schedule a specific date and time for your campaign to be sent.

If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid those times (for example, scheduling at 10:53) can result in lower deferral rates because it won't be going through our servers at the same times as everyone else's mail.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

campaign_idintegerrequired
SchemaExample
send_atintegerrequired

The unix timestamp for the date and time you would like your campaign to be sent out.

201400401403404
SchemaExample
idinteger

The campaign ID.


send_atinteger

The date time you scheduled your campaign to be sent.


statusenum<string>

The status of your campaign.

Possible values:
Scheduled

Schedule a Campaign

schedule-a-campaign page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const campaign_id = 4900;
_22
const data = {
_22
"send_at": 1489771528
_22
};
_22
_22
const request = {
_22
url: `/v3/campaigns/${campaign_id}/schedules`,
_22
method: 'POST',
_22
body: data
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: