Skip to navigation
API ReferenceCampaigns

Update campaign settings

Update some or all of the settings for a specific campaign.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

campaign_idstringRequired
The unique id for the campaign.

Request

A summary of an individual campaign's settings and content.
recipientsobjectOptional
List settings for the campaign.
rss_optsobjectOptional

RSS options for a campaign.

settingsobjectOptional

The settings for your campaign, including subject, from name, reply-to address, and more.

social_cardobjectOptional

The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.

trackingobjectOptional
The tracking options for a campaign.
variate_settingsobjectOptional

The settings specific to A/B test campaigns.

Response

This endpoint returns an object.
typeenum

There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.

Allowed values:
ab_split_optsobjectOptionalRead-only

A/B Testing options for a campaign.

archive_urlstringOptionalRead-only
The link to the campaign's archive version.
content_typestringOptionalRead-only

How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').

create_timedatetimeOptionalRead-only
The date and time the campaign was created in ISO 8601 format.
delivery_statusobjectOptional
Updates on campaigns in the process of sending.
emails_sentintegerOptionalRead-only
The total number of emails sent for this campaign.
idstringOptionalRead-only
A string that uniquely identifies this campaign.
long_archive_urlstringOptionalRead-only
The original link to the campaign's archive version.
needs_block_refreshbooleanOptionalRead-only

Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false.

parent_campaign_idstringOptionalRead-only
If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children.
recipientsobjectOptional
List settings for the campaign.
report_summaryobjectOptional
For sent campaigns, a summary of opens and clicks.
resendablebooleanOptionalRead-only

Determines if the campaign qualifies to be resent to non-openers.

rss_optsobjectOptional

RSS options for a campaign.

send_timedatetimeOptionalRead-only
The date and time a campaign was sent in ISO 8601 format.
settingsobjectOptional

The settings for your campaign, including subject, from name, reply-to address, and more.

social_cardobjectOptional

The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.

statusenumOptionalRead-only
The current status of the campaign.
trackingobjectOptional
The tracking options for a campaign.
variate_settingsobjectOptional

The settings specific to A/B test campaigns.

web_idintegerOptionalRead-only

The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.