MAmailchimp
campaigns

Update campaign settings

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

patch/3.0/campaigns/{campaign_id}

Request

Path parameters

campaign_idstring required

The unique id for the campaign.

Request body

Example request

{
  "recipients": {
    "segment_opts": {
      "conditions": [
        {
          "field": "aim",
          "op": "open",
          "value": "any"
        }
      ],
      "prebuilt_segment_id": "subscribers-female"
    }
  }
}

Response

archive_urlstring

The link to the campaign's archive version.

content_typestring

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

create_timestring date-time

The date and time the campaign was created in ISO 8601 format.

emails_sentinteger

The total number of emails sent for this campaign.

idstring

A string that uniquely identifies this campaign.

long_archive_urlstring

The original link to the campaign's archive version.

needs_block_refreshboolean

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

parent_campaign_idstring

If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children.

resendableboolean

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

send_timestring date-time

The date and time a campaign was sent in ISO 8601 format.

status'save' | 'paused' | 'schedule' | 'sending' | 'sent' | 'canceled' | 'canceling' | 'archived'

The current status of the campaign.

type'regular' | 'plaintext' | 'absplit' | 'rss' | 'variate' required

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.

web_idinteger

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

Example response

{
  "recipients": {
    "segment_opts": {
      "conditions": [
        {
          "field": "aim",
          "op": "open",
          "value": "any"
        }
      ],
      "prebuilt_segment_id": "subscribers-female"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.