Unschedule a Scheduled Campaign
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
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.
DELETE/v3/campaigns/{campaign_id}/schedules
Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)
This endpoint allows you to unschedule a campaign that has already been scheduled to be sent.
A successful unschedule will return a 204. If the specified campaign is in the process of being sent, the only option is to cancel (a different method).
Bearer <<YOUR_API_KEY_HERE>>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.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const campaign_id = 42;56const request = {7url: `/v3/campaigns/${campaign_id}/schedules`,8method: "DELETE",9};1011client12.request(request)13.then(([response, body]) => {14console.log(response.statusCode);15console.log(response.body);16})17.catch((error) => {18console.error(error);19});
