Menu

Campaigns API

Elements that can be shared among more than one endpoint definition.

Update a Campaign

Update a Campaign

PATCH /campaigns/{campaign_id}

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.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Request Body

object
title
string

The title of the campaign.

required
subject
string

The subject line for your campaign.

required
categories
array[string]

The categories you want to tag on this campaign.

required
html_content
string

The HTML content of this campaign.

required
plain_content
string

The plain content of this campaign.

required
{
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "categories": [
    "summer line"
  ],
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!"
}

Path Parameters

campaign_id
integer

The id of the campaign you would like to retrieve.

default: None
required

Responses

object
title
string

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

required
subject
string or null

The subject of your campaign that your recipients will see.

sender_id
integer 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_ids
array[integer] or null

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

segment_ids
array[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.

categories
array[string] or null

The categories you would like associated to this campaign.

suppression_group_id
integer or null

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

custom_unsubscribe_url
string or null

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

ip_pool
string or null

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

html_content
string or null

The HTML of your marketing email.

plain_content
string or null

The plain text content of your emails.

editor
string

The editor used in the UI.

Allowed Values: code, design
status
string

The status of your campaign.

required
id
integer
{
  "id": 986724,
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "summer line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!",
  "status": "Draft"
}
object
object
errors
array[object]
message
string

the error message

field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
object
errors
array[object]
message
string

the error message

field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more