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
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.
This endpoint allows you to update a specific campaign.
This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many of the parameters.
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.
The id of the campaign you would like to retrieve.
application/jsonThe title of the campaign.
The subject line for your campaign.
The categories you want to tag on this campaign.
The HTML content of this campaign.
The plain content of this campaign.
Optional
The display title of your campaign. This will be viewable by you in the Marketing Campaigns UI.
Optional
The subject of your campaign that your recipients will see.
Optional
The ID of the "sender" identity that you have created. Your recipients will see this as the "from" on your marketing emails.
Optional
The IDs of the lists you are sending this campaign to. You can have both segment IDs and list IDs
Optional
The segment IDs that you are sending this list to. You can have both segment IDs and list IDs. Segments are limited to 10 segment IDs.
Optional
The categories you would like associated to this campaign.
Optional
The suppression group that this marketing email belongs to, allowing recipients to opt-out of emails of this type.
Optional
This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups.
Optional
The pool of IPs that you would like to send this email from.
Optional
The HTML of your marketing email.
Optional
The plain text content of your emails.
Optional
The editor used in the UI.
codedesignOptional
The status of your campaign.
Optional
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const campaign_id = 42;5const data = {6title: "May Newsletter",7subject: "New Products for Summer!",8categories: ["summer line"],9html_content:10"<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",11plain_content: "Check out our summer line!",12};1314const request = {15url: `/v3/campaigns/${campaign_id}`,16method: "PATCH",17body: data,18};1920client21.request(request)22.then(([response, body]) => {23console.log(response.statusCode);24console.log(response.body);25})26.catch((error) => {27console.error(error);28});