On this page

Create a Campaign

API Overview

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

Operation overview

POST/v3/campaigns

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

This endpoint allows you to create a campaign.

In order to send or schedule the campaign, you will be required to provide a subject, sender ID, content (we suggest both html and plain text), and at least one list or segment ID. This information is not required when you create a campaign.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

titlestringrequired

The display title of your campaign. This will be viewable by you in the Marketing Campaigns UI.

subjectstring or null

Optional

The subject of your campaign that your recipients will see.

sender_idinteger or null

Optional

The ID of the "sender" identity that you have created. Your recipients will see this as the "from" on your marketing emails.

list_idsarray[integer] or null

Optional

The IDs of the lists you are sending this campaign to. You can have both segment IDs and list IDs

segment_idsarray[integer] or null

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.

categoriesarray[string] or null

Optional

The categories you would like associated to this campaign.

suppression_group_idinteger or null

Optional

The suppression group that this marketing email belongs to, allowing recipients to opt-out of emails of this type.

custom_unsubscribe_urlstring or null

Optional

This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups.

ip_poolstring or null

Optional

The pool of IPs that you would like to send this email from.

html_contentstring or null

Optional

The HTML of your marketing email.

plain_contentstring or null

Optional

The plain text content of your emails.

editorenum<string>

Optional

The editor used in the UI.

Possible values:

codedesign

Responses

201400401

SchemaExample

Property nameTypeRequiredDescriptionChild properties

titlestring

The display title of your campaign. This will be viewable by you in the Marketing Campaigns UI.

subjectstring or null

The subject of your campaign that your recipients will see.

sender_idinteger or null

The ID of the "sender" identity that you have created. Your recipients will see this as the "from" on your marketing emails.

list_idsarray[integer] or null

The IDs of the lists you are sending this campaign to. You can have both segment IDs and list IDs

segment_idsarray[integer] or null

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.

categoriesarray[string] or null

The categories you would like associated to this campaign.

suppression_group_idinteger or null

The suppression group that this marketing email belongs to, allowing recipients to opt-out of emails of this type.

custom_unsubscribe_urlstring or null

This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups.

ip_poolstring or null

The pool of IPs that you would like to send this email from.

html_contentstring or null

The HTML of your marketing email.

plain_contentstring or null

The plain text content of your emails.

editorenum<string>

The editor used in the UI.

Possible values:

codedesign

statusstring

The status of your campaign.

idinteger

The request was formatted incorrectly or missing required parameters.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Create a Campaign

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  id: 986724,
6  title: "May Newsletter",
7  subject: "New Products for Summer!",
8  sender_id: 124451,
9  list_ids: [110, 124],
10  segment_ids: [110],
11  categories: ["summer line"],
12  suppression_group_id: 42,
13  custom_unsubscribe_url: "",
14  ip_pool: "marketing",
15  html_content:
16    "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
17  plain_content: "Check out our summer line!",
18  status: "Draft",
19};
20
21const request = {
22  url: `/v3/campaigns`,
23  method: "POST",
24  body: data,
25};
26
27client
28  .request(request)
29  .then(([response, body]) => {
30    console.log(response.statusCode);
31    console.log(response.body);
32  })
33  .catch((error) => {
34    console.error(error);
35  });