Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
Page tools
On this page
Looking for more inspiration?Visit the

Update a Scheduled Campaign

API Overview

api-overview page anchor
(warning)

Legacy Marketing Campaigns

This covers the obsolete Legacy Marketing Campaigns API.

(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.

Operation overview

operation-overview page anchor

PATCH/v3/campaigns/{campaign_id}/schedules

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

This endpoint allows to you change the scheduled time and date for a campaign to be sent.

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.

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
campaign_idinteger
required

Request body

request-body page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
send_atinteger<int64>
required

Responses

responses page anchor
200400403404
Schema
Property nameTypeRequiredDescriptionChild properties
idinteger

Optional

The campaign ID

send_atinteger

Optional

The unix timestamp to send the campaign.

statusstring

Optional

The status of the schedule.

Update a Scheduled CampaignLink to code sample: Update a Scheduled Campaign
1
const client = require("@sendgrid/client");

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

3


4
const campaign_id = 42;

5
const data = {

6
  send_at: 1489451436,

7
};

8


9
const request = {

10
  url: `/v3/campaigns/${campaign_id}/schedules`,

11
  method: "PATCH",

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
  });