Campaigns

Campaigns are how you send emails to your MailChimp list. Use the Campaigns API calls to manage campaigns in your MailChimp account.

Subresources

Available methods

    • POST /campaigns Create a new campaign

      Create a new campaign

      POST /campaigns

      Create a new MailChimp campaign.

      Request body parameters

      type Type: String Title: Campaign Type Read only: false 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.
      Possible Values:
      • regular
      • plaintext
      • absplit
      • rss
      • variate
      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options. This object should contain a saved_segment_id to use an existing segment, or you can create a new segment by including both match and conditions options.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Conditions Read only: false Segment match conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      settings Type: Object Title: Campaign Settings Read only: false The settings for your campaign, including subject, from name, reply-to address, and more.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      preview_text Type: String Title: Campaign Preview Text Read only: false The preview text for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      use_conversation Type: Boolean Title: Conversation Read only: false Use MailChimp Conversation feature to manage out-of-office replies.
      to_name Type: String Title: To Name Read only: false The campaign’s custom ‘To’ name. Typically the first name merge field.
      folder_id Type: String Title: Folder ID Read only: false If the campaign is listed in a folder, the id for that folder.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      template_id Type: Integer Title: Template ID Read only: false The id of the template to use.
      variate_settings Type: Object Title: A/B Test Options Read only: false The settings specific to A/B test campaigns.
      Show properties
      winner_criteria Type: String Title: Winning Criteria Read only: false The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue—or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with ‘manual’ as the winner_criteria, the winner must be chosen in the MailChimp web application.
      Possible Values:
      • opens
      • clicks
      • manual
      • total_revenue
      wait_time Type: Integer Title: Wait Time Read only: false The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes.
      test_size Type: Integer Title: Test Size Read only: false The percentage of recipients to send the test combinations to, must be a value between 10 and 100.
      subject_lines Type: Array Title: Subject Lines Read only: false The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.
      send_times Type: Array Title: Send Times Read only: false The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.
      from_names Type: Array Title: From Names Read only: false The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.
      reply_to_addresses Type: Array Title: Reply To Addresses Read only: false The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for ClickTale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      rss_opts Type: Object Title: RSS Options Read only: false RSS options for a campaign.
      Show properties
      feed_url Type: String Title: Feed URL Read only: false The URL for the RSS feed.
      frequency Type: String Title: Frequency Read only: false The frequency of the RSS Campaign.
      Possible Values:
      • daily
      • weekly
      • monthly
      schedule Type: Object Title: Sending Schedule Read only: false The schedule for sending the RSS Campaign.
      Show properties
      hour Type: Integer Title: Sending Hour Read only: false The hour to send the campaign in local time. Acceptable hours are 0-23. For example, ‘4’ would be 4am in your account’s default time zone.
      daily_send Type: Object Title: Daily Sending Days Read only: false The days of the week to send a daily RSS Campaign.
      Show properties
      sunday Type: Boolean Title: Sunday Read only: false Sends the daily RSS Campaign on Sundays.
      monday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Mondays.
      tuesday Type: Boolean Title: tuesday Read only: false Sends the daily RSS Campaign on Tuesdays.
      wednesday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Wednesdays.
      thursday Type: Boolean Title: Thursday Read only: false Sends the daily RSS Campaign on Thursdays.
      friday Type: Boolean Title: Friday Read only: false Sends the daily RSS Campaign on Fridays.
      saturday Type: Boolean Title: Saturday Read only: false Sends the daily RSS Campaign on Saturdays.
      weekly_send_day Type: String Title: Weekly Sending Day Read only: false The day of the week to send a weekly RSS Campaign.
      Possible Values:
      • sunday
      • monday
      • tuesday
      • wednesday
      • thursday
      • friday
      • saturday
      monthly_send_date Type: Number Title: Monthly Sending Day Read only: false The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where ‘0’ is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February.
      constrain_rss_img Type: Boolean Title: Constrain RSS Images Read only: false Whether to add CSS to images in the RSS feed to constrain their width in campaigns.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.

      Response body parameters

      id Type: String Title: Campaign ID Read only: true A string that uniquely identifies this campaign.
      web_id Type: Integer Title: Campaign Web ID Read only: true 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}.
      type Type: String Title: Campaign Type Read only: false 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.
      Possible Values:
      • regular
      • plaintext
      • absplit
      • rss
      • variate
      create_time Type: String Title: Create Time Read only: true The date and time the campaign was created.
      archive_url Type: String Title: Archive URL Read only: true The link to the campaign’s archive version.
      long_archive_url Type: String Title: Long Archive URL Read only: true The original link to the campaign’s archive version.
      status Type: String Title: Campaign Status Read only: true The current status of the campaign.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails sent for this campaign.
      send_time Type: String Title: Send Time Read only: true The date and time a campaign was sent.
      content_type Type: String Title: Content Type Read only: true How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
      needs_block_refresh Type: Boolean Title: Needs Block Refresh Read only: false Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor.
      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      list_name Type: String Title: List Name Read only: true The name of the list.
      segment_text Type: String Title: Segment Text Read only: true A description of the segment used for the campaign. Formatted as a string marked up with HTML.
      recipient_count Type: Integer Title: Recipient Count Read only: true Count of the recipients on the associated list. Formatted as an integer.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options. This object should contain a saved_segment_id to use an existing segment, or you can create a new segment by including both match and conditions options.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Conditions Read only: false Segment match conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      settings Type: Object Title: Campaign Settings Read only: false The settings for your campaign, including subject, from name, reply-to address, and more.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      preview_text Type: String Title: Campaign Preview Text Read only: false The preview text for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      use_conversation Type: Boolean Title: Conversation Read only: false Use MailChimp Conversation feature to manage out-of-office replies.
      to_name Type: String Title: To Name Read only: false The campaign’s custom ‘To’ name. Typically the first name merge field.
      folder_id Type: String Title: Folder ID Read only: false If the campaign is listed in a folder, the id for that folder.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      timewarp Type: Boolean Title: Timewarp Send Read only: true Send this campaign using Timewarp.
      template_id Type: Integer Title: Template ID Read only: false The id for the template used in this campaign.
      drag_and_drop Type: Boolean Title: Drag And Drop Campaign Read only: true Whether the campaign uses the drag-and-drop editor.
      variate_settings Type: Object Title: A/B Test Options Read only: false The settings specific to A/B test campaigns.
      Show properties
      winning_combination_id Type: String Title: Winning Combination ID Read only: true ID for the winning combination.
      winning_campaign_id Type: String Title: Winning Campaign ID Read only: true ID of the campaign that was sent to the remaining recipients based on the winning combination.
      winner_criteria Type: String Title: Winning Criteria Read only: false The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue—or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with ‘manual’ as the winner_criteria, the winner must be chosen in the MailChimp web application.
      Possible Values:
      • opens
      • clicks
      • manual
      • total_revenue
      wait_time Type: Integer Title: Wait Time Read only: false The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes.
      test_size Type: Integer Title: Test Size Read only: false The percentage of recipients to send the test combinations to, must be a value between 10 and 100.
      subject_lines Type: Array Title: Subject Lines Read only: false The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.
      send_times Type: Array Title: Send Times Read only: false The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.
      from_names Type: Array Title: From Names Read only: false The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.
      reply_to_addresses Type: Array Title: Reply To Addresses Read only: false The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.
      contents Type: Array Title: Content Descriptions Read only: true Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field ‘variate_contents’.
      combinations Type: Array Title: Combinations Read only: true Combinations of possible variables used to build emails.
      Show properties
      id Type: String Title: ID Read only: false Unique ID for the combination.
      subject_line Type: Integer Title: Subject Line Read only: false The index of variate_settings.subject_lines used.
      send_time Type: Integer Title: Send Time Read only: false The index of variate_settings.send_times used.
      from_name Type: Integer Title: From Name Read only: false The index of variate_settings.from_names used.
      reply_to Type: Integer Title: Reply To Read only: false The index of variate_settings.reply_to_addresses used.
      content_description Type: Integer Title: Content Description Read only: false The index of variate_settings.contents used.
      recipients Type: Integer Title: Recipients Read only: false The number of recipients for this combination.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for ClickTale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      rss_opts Type: Object Title: RSS Options Read only: false RSS options for a campaign.
      Show properties
      feed_url Type: String Title: Feed URL Read only: false The URL for the RSS feed.
      frequency Type: String Title: Frequency Read only: false The frequency of the RSS Campaign.
      Possible Values:
      • daily
      • weekly
      • monthly
      schedule Type: Object Title: Sending Schedule Read only: false The schedule for sending the RSS Campaign.
      Show properties
      hour Type: Integer Title: Sending Hour Read only: false The hour to send the campaign in local time. Acceptable hours are 0-23. For example, ‘4’ would be 4am in your account’s default time zone.
      daily_send Type: Object Title: Daily Sending Days Read only: false The days of the week to send a daily RSS Campaign.
      Show properties
      sunday Type: Boolean Title: Sunday Read only: false Sends the daily RSS Campaign on Sundays.
      monday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Mondays.
      tuesday Type: Boolean Title: tuesday Read only: false Sends the daily RSS Campaign on Tuesdays.
      wednesday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Wednesdays.
      thursday Type: Boolean Title: Thursday Read only: false Sends the daily RSS Campaign on Thursdays.
      friday Type: Boolean Title: Friday Read only: false Sends the daily RSS Campaign on Fridays.
      saturday Type: Boolean Title: Saturday Read only: false Sends the daily RSS Campaign on Saturdays.
      weekly_send_day Type: String Title: Weekly Sending Day Read only: false The day of the week to send a weekly RSS Campaign.
      Possible Values:
      • sunday
      • monday
      • tuesday
      • wednesday
      • thursday
      • friday
      • saturday
      monthly_send_date Type: Number Title: Monthly Sending Day Read only: false The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where ‘0’ is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February.
      last_sent Type: String Title: Last Sent Read only: true The date the campaign was last sent.
      constrain_rss_img Type: Boolean Title: Constrain RSS Images Read only: false Whether to add CSS to images in the RSS feed to constrain their width in campaigns.
      ab_split_opts Type: Object Title: A/B Testing Options Read only: true A/B Testing options for a campaign.
      Show properties
      split_test Type: String Title: Split Test Read only: false The type of AB split to run.
      Possible Values:
      • subject
      • from_name
      • schedule
      pick_winner Type: String Title: Pick Winner Read only: false How we should evaluate a winner. Based on ‘opens’, ‘clicks’, or ‘manual’.
      Possible Values:
      • opens
      • clicks
      • manual
      wait_units Type: String Title: Wait Time Read only: false How unit of time for measuring the winner (‘hours’ or ‘days’). This cannot be changed after a campaign is sent.
      Possible Values:
      • hours
      • days
      wait_time Type: Integer Title: Wait Time Read only: false The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent.
      split_size Type: Integer Title: Split Size Read only: false The size of the split groups. Campaigns split based on ‘schedule’ are forced to have a 5050 split. Valid split integers are between 1-50.
      from_name_a Type: String Title: From Name Group A Read only: false For campaigns split on ‘From Name’, the name for Group A.
      from_name_b Type: String Title: From Name Group B Read only: false For campaigns split on ‘From Name’, the name for Group B.
      reply_email_a Type: String Title: Reply Email Group A Read only: false For campaigns split on ‘From Name’, the reply-to address for Group A.
      reply_email_b Type: String Title: Reply Email Group B Read only: false For campaigns split on ‘From Name’, the reply-to address for Group B.
      subject_a Type: String Title: Subject Line Group A Read only: false For campaigns split on ‘Subject Line’, the subject line for Group A.
      subject_b Type: String Title: Subject Line Group B Read only: false For campaigns split on ‘Subject Line’, the subject line for Group B.
      send_time_a Type: String Title: Send Time Group A Read only: false The send time for Group A.
      send_time_b Type: String Title: Send Time Group B Read only: false The send time for Group B.
      send_time_winner Type: String Title: Send Time Winner Read only: false The send time for the winning version.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.
      report_summary Type: Object Title: Campaign Report Summary Read only: false For sent campaigns, a summary of opens, clicks, and e-commerce data.
      Show properties
      opens Type: Integer Title: Automation Opens Read only: true The total number of opens for a campaign.
      unique_opens Type: Integer Title: Unique Opens Read only: true The number of unique opens.
      open_rate Type: Number Title: Open Rate Read only: true The number of unique opens divided by the total number of successful deliveries.
      clicks Type: Integer Title: Total Clicks Read only: true The total number of clicks for an campaign.
      subscriber_clicks Type: Integer Title: Unique Subscriber Clicks Read only: true The number of unique clicks.
      click_rate Type: Number Title: Click Rate Read only: true The number of unique clicks divided by the total number of successful deliveries.
      ecommerce Type: Object Title: E-Commerce Report Read only: false E-Commerce stats for a campaign.
      Show properties
      total_orders Type: Integer Title: Total Orders Read only: true The total orders for a campaign.
      total_spent Type: Number Title: Total Spent Read only: true The total spent for a campaign. Calculated as the sum of all order totals with no deductions.
      total_revenue Type: Number Title: Total Revenue Read only: true The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.
      delivery_status Type: Object Title: Campaign Delivery Status Read only: false Updates on campaigns in the process of sending.
      Show properties
      enabled Type: Boolean Title: Delivery Status Enabled Read only: true Whether Campaign Delivery Status is enabled for this account and campaign.
      can_cancel Type: Boolean Title: Campaign Cancelable Read only: true Whether a campaign send can be canceled.
      status Type: String Title: Campaign Delivery Status Read only: true The current state of a campaign delivery.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails confirmed sent for this campaign so far.
      emails_canceled Type: Integer Title: Emails Canceled Read only: true The total number of emails canceled for this campaign.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"recipients":{"list_id":"3c307a9f3f"},"type":"regular","settings":{"subject_line":"Your Purchase Receipt","reply_to":"orders@mammothhouse.com","from_name":"Customer Service"}}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2140
      Vary: Accept-Encoding
      X-Request-Id: 8a28ac40-23bc-458f-a198-70f26ace24e5
      Link: <https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json>; rel="describedBy", <https://usX.admin.mailchimp.com/campaigns/show?id=2209445>; rel="dashboard"
      Date: Fri, 20 Nov 2015 22:06:57 GMT
      Connection: keep-alive
      
      {
        "id": "3e06f4ec92",
        "type": "regular",
        "create_time": "2015-11-20T22:06:56+00:00",
        "archive_url": "http://eepurl.com/XXXX",
        "status": "save",
        "emails_sent": 0,
        "send_time": "",
        "content_type": "template",
        "recipients": {
          "list_id": "3c307a9f3f",
          "segment_text": ""
        },
        "settings": {
          "subject_line": "Your Purchase Receipt",
          "title": "",
          "from_name": "Customer Service",
          "reply_to": "orders@mammothhouse.com",
          "use_conversation": false,
          "to_name": "",
          "folder_id": "",
          "authenticate": true,
          "auto_footer": false,
          "inline_css": false,
          "auto_tweet": false,
          "fb_comments": true,
          "timewarp": false,
          "template_id": 0,
          "drag_and_drop": false
        },
        "tracking": {
          "opens": true,
          "html_clicks": true,
          "text_clicks": false,
          "goal_tracking": false,
          "ecomm360": false,
          "google_analytics": "",
          "clicktale": "N"
        },
        "delivery_status": {
          "enabled": false
        },
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92",
            "method": "DELETE"
          },
          {
            "rel": "send",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/actions/send",
            "method": "POST"
          },
          {
            "rel": "cancel_send",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/actions/cancel-send",
            "method": "POST"
          },
          {
            "rel": "feedback",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/feedback",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Feedback/Collection.json"
          },
          {
            "rel": "content",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/content",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Content/Collection.json"
          },
          {
            "rel": "send_checklist",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/send-checklist",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Checklist/Collection.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • GET /campaigns Get all campaigns
      GET /campaigns/{campaign_id} Get information about a specific campaign

      Get all campaigns

      GET /campaigns

      Get all campaigns in an account.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
      type Type: String Title: Campaign Type Read only: false The campaign type.
      Possible Values:
      • regular
      • plaintext
      • absplit
      • rss
      • variate
      status Type: String Title: Status Read only: false The status of the campaign.
      before_send_time Type: String Title: Before Send Time Read only: false Restrict the response to campaigns sent before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
      since_send_time Type: String Title: Since Send Time Read only: false Restrict the response to campaigns sent after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
      before_create_time Type: String Title: Before Create Time Read only: false Restrict the response to campaigns created before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
      since_create_time Type: String Title: Since Create Time Read only: false Restrict the response to campaigns created after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
      list_id Type: String Title: List ID Read only: false The unique id for the list.
      folder_id Type: String Title: Folder ID Read only: false The unique folder id.
      sort_field Type: String Title: Sort By Field Read only: false Returns files sorted by the specified field.
      Possible Values:
      • create_time
      • send_time
      sort_dir Type: String Title: Sort Direction Read only: false Determines the order direction for sorted results.
      Possible Values:
      • ASC
      • DESC

      Response body parameters

      campaigns Type: Array Title: Campaigns Read only: false An array of campaigns.
      Show properties
      id Type: String Title: Campaign ID Read only: true A string that uniquely identifies this campaign.
      web_id Type: Integer Title: Campaign Web ID Read only: true 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}.
      type Type: String Title: Campaign Type Read only: false 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.
      Possible Values:
      • regular
      • plaintext
      • absplit
      • rss
      • variate
      create_time Type: String Title: Create Time Read only: true The date and time the campaign was created.
      archive_url Type: String Title: Archive URL Read only: true The link to the campaign’s archive version.
      long_archive_url Type: String Title: Long Archive URL Read only: true The original link to the campaign’s archive version.
      status Type: String Title: Campaign Status Read only: true The current status of the campaign.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails sent for this campaign.
      send_time Type: String Title: Send Time Read only: true The date and time a campaign was sent.
      content_type Type: String Title: Content Type Read only: true How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
      needs_block_refresh Type: Boolean Title: Needs Block Refresh Read only: false Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor.
      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      list_name Type: String Title: List Name Read only: true The name of the list.
      segment_text Type: String Title: Segment Text Read only: true A description of the segment used for the campaign. Formatted as a string marked up with HTML.
      recipient_count Type: Integer Title: Recipient Count Read only: true Count of the recipients on the associated list. Formatted as an integer.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options. This object should contain a saved_segment_id to use an existing segment, or you can create a new segment by including both match and conditions options.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Conditions Read only: false Segment match conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      settings Type: Object Title: Campaign Settings Read only: false The settings for your campaign, including subject, from name, reply-to address, and more.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      preview_text Type: String Title: Campaign Preview Text Read only: false The preview text for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      use_conversation Type: Boolean Title: Conversation Read only: false Use MailChimp Conversation feature to manage out-of-office replies.
      to_name Type: String Title: To Name Read only: false The campaign’s custom ‘To’ name. Typically the first name merge field.
      folder_id Type: String Title: Folder ID Read only: false If the campaign is listed in a folder, the id for that folder.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      timewarp Type: Boolean Title: Timewarp Send Read only: true Send this campaign using Timewarp.
      template_id Type: Integer Title: Template ID Read only: false The id for the template used in this campaign.
      drag_and_drop Type: Boolean Title: Drag And Drop Campaign Read only: true Whether the campaign uses the drag-and-drop editor.
      variate_settings Type: Object Title: A/B Test Options Read only: false The settings specific to A/B test campaigns.
      Show properties
      winning_combination_id Type: String Title: Winning Combination ID Read only: true ID for the winning combination.
      winning_campaign_id Type: String Title: Winning Campaign ID Read only: true ID of the campaign that was sent to the remaining recipients based on the winning combination.
      winner_criteria Type: String Title: Winning Criteria Read only: false The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue—or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with ‘manual’ as the winner_criteria, the winner must be chosen in the MailChimp web application.
      Possible Values:
      • opens
      • clicks
      • manual
      • total_revenue
      wait_time Type: Integer Title: Wait Time Read only: false The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes.
      test_size Type: Integer Title: Test Size Read only: false The percentage of recipients to send the test combinations to, must be a value between 10 and 100.
      subject_lines Type: Array Title: Subject Lines Read only: false The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.
      send_times Type: Array Title: Send Times Read only: false The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.
      from_names Type: Array Title: From Names Read only: false The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.
      reply_to_addresses Type: Array Title: Reply To Addresses Read only: false The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.
      contents Type: Array Title: Content Descriptions Read only: true Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field ‘variate_contents’.
      combinations Type: Array Title: Combinations Read only: true Combinations of possible variables used to build emails.
      Show properties
      id Type: String Title: ID Read only: false Unique ID for the combination.
      subject_line Type: Integer Title: Subject Line Read only: false The index of variate_settings.subject_lines used.
      send_time Type: Integer Title: Send Time Read only: false The index of variate_settings.send_times used.
      from_name Type: Integer Title: From Name Read only: false The index of variate_settings.from_names used.
      reply_to Type: Integer Title: Reply To Read only: false The index of variate_settings.reply_to_addresses used.
      content_description Type: Integer Title: Content Description Read only: false The index of variate_settings.contents used.
      recipients Type: Integer Title: Recipients Read only: false The number of recipients for this combination.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for ClickTale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      rss_opts Type: Object Title: RSS Options Read only: false RSS options for a campaign.
      Show properties
      feed_url Type: String Title: Feed URL Read only: false The URL for the RSS feed.
      frequency Type: String Title: Frequency Read only: false The frequency of the RSS Campaign.
      Possible Values:
      • daily
      • weekly
      • monthly
      schedule Type: Object Title: Sending Schedule Read only: false The schedule for sending the RSS Campaign.
      Show properties
      hour Type: Integer Title: Sending Hour Read only: false The hour to send the campaign in local time. Acceptable hours are 0-23. For example, ‘4’ would be 4am in your account’s default time zone.
      daily_send Type: Object Title: Daily Sending Days Read only: false The days of the week to send a daily RSS Campaign.
      Show properties
      sunday Type: Boolean Title: Sunday Read only: false Sends the daily RSS Campaign on Sundays.
      monday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Mondays.
      tuesday Type: Boolean Title: tuesday Read only: false Sends the daily RSS Campaign on Tuesdays.
      wednesday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Wednesdays.
      thursday Type: Boolean Title: Thursday Read only: false Sends the daily RSS Campaign on Thursdays.
      friday Type: Boolean Title: Friday Read only: false Sends the daily RSS Campaign on Fridays.
      saturday Type: Boolean Title: Saturday Read only: false Sends the daily RSS Campaign on Saturdays.
      weekly_send_day Type: String Title: Weekly Sending Day Read only: false The day of the week to send a weekly RSS Campaign.
      Possible Values:
      • sunday
      • monday
      • tuesday
      • wednesday
      • thursday
      • friday
      • saturday
      monthly_send_date Type: Number Title: Monthly Sending Day Read only: false The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where ‘0’ is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February.
      last_sent Type: String Title: Last Sent Read only: true The date the campaign was last sent.
      constrain_rss_img Type: Boolean Title: Constrain RSS Images Read only: false Whether to add CSS to images in the RSS feed to constrain their width in campaigns.
      ab_split_opts Type: Object Title: A/B Testing Options Read only: true A/B Testing options for a campaign.
      Show properties
      split_test Type: String Title: Split Test Read only: false The type of AB split to run.
      Possible Values:
      • subject
      • from_name
      • schedule
      pick_winner Type: String Title: Pick Winner Read only: false How we should evaluate a winner. Based on ‘opens’, ‘clicks’, or ‘manual’.
      Possible Values:
      • opens
      • clicks
      • manual
      wait_units Type: String Title: Wait Time Read only: false How unit of time for measuring the winner (‘hours’ or ‘days’). This cannot be changed after a campaign is sent.
      Possible Values:
      • hours
      • days
      wait_time Type: Integer Title: Wait Time Read only: false The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent.
      split_size Type: Integer Title: Split Size Read only: false The size of the split groups. Campaigns split based on ‘schedule’ are forced to have a 5050 split. Valid split integers are between 1-50.
      from_name_a Type: String Title: From Name Group A Read only: false For campaigns split on ‘From Name’, the name for Group A.
      from_name_b Type: String Title: From Name Group B Read only: false For campaigns split on ‘From Name’, the name for Group B.
      reply_email_a Type: String Title: Reply Email Group A Read only: false For campaigns split on ‘From Name’, the reply-to address for Group A.
      reply_email_b Type: String Title: Reply Email Group B Read only: false For campaigns split on ‘From Name’, the reply-to address for Group B.
      subject_a Type: String Title: Subject Line Group A Read only: false For campaigns split on ‘Subject Line’, the subject line for Group A.
      subject_b Type: String Title: Subject Line Group B Read only: false For campaigns split on ‘Subject Line’, the subject line for Group B.
      send_time_a Type: String Title: Send Time Group A Read only: false The send time for Group A.
      send_time_b Type: String Title: Send Time Group B Read only: false The send time for Group B.
      send_time_winner Type: String Title: Send Time Winner Read only: false The send time for the winning version.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.
      report_summary Type: Object Title: Campaign Report Summary Read only: false For sent campaigns, a summary of opens, clicks, and e-commerce data.
      Show properties
      opens Type: Integer Title: Automation Opens Read only: true The total number of opens for a campaign.
      unique_opens Type: Integer Title: Unique Opens Read only: true The number of unique opens.
      open_rate Type: Number Title: Open Rate Read only: true The number of unique opens divided by the total number of successful deliveries.
      clicks Type: Integer Title: Total Clicks Read only: true The total number of clicks for an campaign.
      subscriber_clicks Type: Integer Title: Unique Subscriber Clicks Read only: true The number of unique clicks.
      click_rate Type: Number Title: Click Rate Read only: true The number of unique clicks divided by the total number of successful deliveries.
      ecommerce Type: Object Title: E-Commerce Report Read only: false E-Commerce stats for a campaign.
      Show properties
      total_orders Type: Integer Title: Total Orders Read only: true The total orders for a campaign.
      total_spent Type: Number Title: Total Spent Read only: true The total spent for a campaign. Calculated as the sum of all order totals with no deductions.
      total_revenue Type: Number Title: Total Revenue Read only: true The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.
      delivery_status Type: Object Title: Campaign Delivery Status Read only: false Updates on campaigns in the process of sending.
      Show properties
      enabled Type: Boolean Title: Delivery Status Enabled Read only: true Whether Campaign Delivery Status is enabled for this account and campaign.
      can_cancel Type: Boolean Title: Campaign Cancelable Read only: true Whether a campaign send can be canceled.
      status Type: String Title: Campaign Delivery Status Read only: true The current state of a campaign delivery.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails confirmed sent for this campaign so far.
      emails_canceled Type: Integer Title: Emails Canceled Read only: true The total number of emails canceled for this campaign.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Vary: Accept-Encoding
      X-Request-Id: 880b0eda-0ce1-4815-bf50-2ed6ffa98ff7
      Link: <https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json>; rel="describedBy"
      Date: Tue, 15 Sep 2015 17:59:52 GMT
      Content-Length: 19586
      Connection: keep-alive
      
      
      {
        "campaigns": [
          {
            "id": "42694e9e57",
            "type": "regular",
            "create_time": "2015-09-15T14:40:36+00:00",
            "archive_url": "http://eepurl.com/xxxx",
            "status": "save",
            "emails_sent": 0,
            "send_time": "",
            "content_type": "template",
            "recipients": {
              "list_id": "57afe96172",
              "segment_text": ""
            },
            "settings": {
              "subject_line": "I have a rice crispy treat watermelon farm.",
              "title": "Freddie's Jokes Vol. 1",
              "from_name": "Freddie",
              "reply_to": "freddie@freddiesjokes.com",
              "use_conversation": false,
              "to_name": "",
              "folder_id": 0,
              "authenticate": true,
              "auto_footer": false,
              "inline_css": false,
              "auto_tweet": false,
              "fb_comments": false,
              "timewarp": false,
              "template_id": 100,
              "drag_and_drop": true
            },
            "tracking": {
              "opens": true,
              "html_clicks": true,
              "text_clicks": false,
              "goal_tracking": true,
              "ecomm360": true,
              "google_analytics": true,
              "clicktale": ""
            },
            "delivery_status": {
              "enabled": false
            },
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57",
                "method": "DELETE"
              },
              {
                "rel": "cancel_send",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57/actions/cancel-send",
                "method": "POST"
              },
              {
                "rel": "feedback",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57/feedback",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Feedback/Collection.json"
              }
            ]
          },
          {
            "id": "f6276207cc",
            "type": "regular",
            "create_time": "2015-07-20T15:40:41+00:00",
            "archive_url": "http://eepurl.com/xxxx",
            "status": "sent",
            "emails_sent": 1,
            "send_time": "2015-07-20T15:42:48+00:00",
            "content_type": "template",
            "recipients": {
              "list_id": "1a2df69511",
              "segment_text": "<p class=\"nomargin\">Subscribers match <strong>any</strong> of the following conditions:</p><ol id=\"conditions\" class=\"conditions\"><li class=\"mar-lv1 mar-lr0\">Static Segments member is part of <strong>Campaign Pasted Segment - 20 Jul 2015 11:41:09 am</strong></li></ol><span>For a total of <strong>1</strong> emails sent.</span>",
              "segment_opts": {
                "saved_segment_id": 48501,
                "match": "any",
                "conditions": [
                  {
                    "field": "static_segment",
                    "op": "static_is",
                    "value": 48501
                  }
                ]
              }
            },
            "settings": {
              "subject_line": "Take my poll!",
              "title": "Poll test",
              "from_name": "Freddie",
              "reply_to": "freddie@freddiesjokes.com",
              "use_conversation": false,
              "to_name": "*|FNAME|*",
              "folder_id": 0,
              "authenticate": true,
              "auto_footer": false,
              "inline_css": false,
              "auto_tweet": false,
              "fb_comments": false,
              "timewarp": false,
              "template_id": 91,
              "drag_and_drop": true
            },
            "tracking": {
              "opens": true,
              "html_clicks": true,
              "text_clicks": false,
              "goal_tracking": false,
              "ecomm360": false,
              "google_analytics": true,
              "clicktale": ""
            },
            "report_summary": {
              "opens": 1,
              "unique_opens": 1,
              "open_rate": 1,
              "clicks": 0,
              "subscriber_clicks": 0,
              "click_rate": 0
            },
            "delivery_status": {
              "enabled": false
            },
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/f6276207cc",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/f6276207cc",
                "method": "DELETE"
              },
              {
                "rel": "cancel_send",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/f6276207cc/actions/cancel-send",
                "method": "POST"
              },
              {
                "rel": "feedback",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/f6276207cc/feedback",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Feedback/Collection.json"
              }
            ]
          }
        ],
        "total_items": 2,
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Root.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Get information about a specific campaign

      GET /campaigns/{campaign_id}

      Get information about a specific campaign.

      Path parameters

      campaign_id The unique id for the campaign.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      id Type: String Title: Campaign ID Read only: true A string that uniquely identifies this campaign.
      web_id Type: Integer Title: Campaign Web ID Read only: true 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}.
      type Type: String Title: Campaign Type Read only: false 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.
      Possible Values:
      • regular
      • plaintext
      • absplit
      • rss
      • variate
      create_time Type: String Title: Create Time Read only: true The date and time the campaign was created.
      archive_url Type: String Title: Archive URL Read only: true The link to the campaign’s archive version.
      long_archive_url Type: String Title: Long Archive URL Read only: true The original link to the campaign’s archive version.
      status Type: String Title: Campaign Status Read only: true The current status of the campaign.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails sent for this campaign.
      send_time Type: String Title: Send Time Read only: true The date and time a campaign was sent.
      content_type Type: String Title: Content Type Read only: true How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
      needs_block_refresh Type: Boolean Title: Needs Block Refresh Read only: false Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor.
      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      list_name Type: String Title: List Name Read only: true The name of the list.
      segment_text Type: String Title: Segment Text Read only: true A description of the segment used for the campaign. Formatted as a string marked up with HTML.
      recipient_count Type: Integer Title: Recipient Count Read only: true Count of the recipients on the associated list. Formatted as an integer.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options. This object should contain a saved_segment_id to use an existing segment, or you can create a new segment by including both match and conditions options.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Conditions Read only: false Segment match conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      settings Type: Object Title: Campaign Settings Read only: false The settings for your campaign, including subject, from name, reply-to address, and more.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      preview_text Type: String Title: Campaign Preview Text Read only: false The preview text for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      use_conversation Type: Boolean Title: Conversation Read only: false Use MailChimp Conversation feature to manage out-of-office replies.
      to_name Type: String Title: To Name Read only: false The campaign’s custom ‘To’ name. Typically the first name merge field.
      folder_id Type: String Title: Folder ID Read only: false If the campaign is listed in a folder, the id for that folder.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      timewarp Type: Boolean Title: Timewarp Send Read only: true Send this campaign using Timewarp.
      template_id Type: Integer Title: Template ID Read only: false The id for the template used in this campaign.
      drag_and_drop Type: Boolean Title: Drag And Drop Campaign Read only: true Whether the campaign uses the drag-and-drop editor.
      variate_settings Type: Object Title: A/B Test Options Read only: false The settings specific to A/B test campaigns.
      Show properties
      winning_combination_id Type: String Title: Winning Combination ID Read only: true ID for the winning combination.
      winning_campaign_id Type: String Title: Winning Campaign ID Read only: true ID of the campaign that was sent to the remaining recipients based on the winning combination.
      winner_criteria Type: String Title: Winning Criteria Read only: false The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue—or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with ‘manual’ as the winner_criteria, the winner must be chosen in the MailChimp web application.
      Possible Values:
      • opens
      • clicks
      • manual
      • total_revenue
      wait_time Type: Integer Title: Wait Time Read only: false The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes.
      test_size Type: Integer Title: Test Size Read only: false The percentage of recipients to send the test combinations to, must be a value between 10 and 100.
      subject_lines Type: Array Title: Subject Lines Read only: false The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.
      send_times Type: Array Title: Send Times Read only: false The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.
      from_names Type: Array Title: From Names Read only: false The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.
      reply_to_addresses Type: Array Title: Reply To Addresses Read only: false The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.
      contents Type: Array Title: Content Descriptions Read only: true Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field ‘variate_contents’.
      combinations Type: Array Title: Combinations Read only: true Combinations of possible variables used to build emails.
      Show properties
      id Type: String Title: ID Read only: false Unique ID for the combination.
      subject_line Type: Integer Title: Subject Line Read only: false The index of variate_settings.subject_lines used.
      send_time Type: Integer Title: Send Time Read only: false The index of variate_settings.send_times used.
      from_name Type: Integer Title: From Name Read only: false The index of variate_settings.from_names used.
      reply_to Type: Integer Title: Reply To Read only: false The index of variate_settings.reply_to_addresses used.
      content_description Type: Integer Title: Content Description Read only: false The index of variate_settings.contents used.
      recipients Type: Integer Title: Recipients Read only: false The number of recipients for this combination.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for ClickTale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      rss_opts Type: Object Title: RSS Options Read only: false RSS options for a campaign.
      Show properties
      feed_url Type: String Title: Feed URL Read only: false The URL for the RSS feed.
      frequency Type: String Title: Frequency Read only: false The frequency of the RSS Campaign.
      Possible Values:
      • daily
      • weekly
      • monthly
      schedule Type: Object Title: Sending Schedule Read only: false The schedule for sending the RSS Campaign.
      Show properties
      hour Type: Integer Title: Sending Hour Read only: false The hour to send the campaign in local time. Acceptable hours are 0-23. For example, ‘4’ would be 4am in your account’s default time zone.
      daily_send Type: Object Title: Daily Sending Days Read only: false The days of the week to send a daily RSS Campaign.
      Show properties
      sunday Type: Boolean Title: Sunday Read only: false Sends the daily RSS Campaign on Sundays.
      monday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Mondays.
      tuesday Type: Boolean Title: tuesday Read only: false Sends the daily RSS Campaign on Tuesdays.
      wednesday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Wednesdays.
      thursday Type: Boolean Title: Thursday Read only: false Sends the daily RSS Campaign on Thursdays.
      friday Type: Boolean Title: Friday Read only: false Sends the daily RSS Campaign on Fridays.
      saturday Type: Boolean Title: Saturday Read only: false Sends the daily RSS Campaign on Saturdays.
      weekly_send_day Type: String Title: Weekly Sending Day Read only: false The day of the week to send a weekly RSS Campaign.
      Possible Values:
      • sunday
      • monday
      • tuesday
      • wednesday
      • thursday
      • friday
      • saturday
      monthly_send_date Type: Number Title: Monthly Sending Day Read only: false The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where ‘0’ is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February.
      last_sent Type: String Title: Last Sent Read only: true The date the campaign was last sent.
      constrain_rss_img Type: Boolean Title: Constrain RSS Images Read only: false Whether to add CSS to images in the RSS feed to constrain their width in campaigns.
      ab_split_opts Type: Object Title: A/B Testing Options Read only: true A/B Testing options for a campaign.
      Show properties
      split_test Type: String Title: Split Test Read only: false The type of AB split to run.
      Possible Values:
      • subject
      • from_name
      • schedule
      pick_winner Type: String Title: Pick Winner Read only: false How we should evaluate a winner. Based on ‘opens’, ‘clicks’, or ‘manual’.
      Possible Values:
      • opens
      • clicks
      • manual
      wait_units Type: String Title: Wait Time Read only: false How unit of time for measuring the winner (‘hours’ or ‘days’). This cannot be changed after a campaign is sent.
      Possible Values:
      • hours
      • days
      wait_time Type: Integer Title: Wait Time Read only: false The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent.
      split_size Type: Integer Title: Split Size Read only: false The size of the split groups. Campaigns split based on ‘schedule’ are forced to have a 5050 split. Valid split integers are between 1-50.
      from_name_a Type: String Title: From Name Group A Read only: false For campaigns split on ‘From Name’, the name for Group A.
      from_name_b Type: String Title: From Name Group B Read only: false For campaigns split on ‘From Name’, the name for Group B.
      reply_email_a Type: String Title: Reply Email Group A Read only: false For campaigns split on ‘From Name’, the reply-to address for Group A.
      reply_email_b Type: String Title: Reply Email Group B Read only: false For campaigns split on ‘From Name’, the reply-to address for Group B.
      subject_a Type: String Title: Subject Line Group A Read only: false For campaigns split on ‘Subject Line’, the subject line for Group A.
      subject_b Type: String Title: Subject Line Group B Read only: false For campaigns split on ‘Subject Line’, the subject line for Group B.
      send_time_a Type: String Title: Send Time Group A Read only: false The send time for Group A.
      send_time_b Type: String Title: Send Time Group B Read only: false The send time for Group B.
      send_time_winner Type: String Title: Send Time Winner Read only: false The send time for the winning version.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.
      report_summary Type: Object Title: Campaign Report Summary Read only: false For sent campaigns, a summary of opens, clicks, and e-commerce data.
      Show properties
      opens Type: Integer Title: Automation Opens Read only: true The total number of opens for a campaign.
      unique_opens Type: Integer Title: Unique Opens Read only: true The number of unique opens.
      open_rate Type: Number Title: Open Rate Read only: true The number of unique opens divided by the total number of successful deliveries.
      clicks Type: Integer Title: Total Clicks Read only: true The total number of clicks for an campaign.
      subscriber_clicks Type: Integer Title: Unique Subscriber Clicks Read only: true The number of unique clicks.
      click_rate Type: Number Title: Click Rate Read only: true The number of unique clicks divided by the total number of successful deliveries.
      ecommerce Type: Object Title: E-Commerce Report Read only: false E-Commerce stats for a campaign.
      Show properties
      total_orders Type: Integer Title: Total Orders Read only: true The total orders for a campaign.
      total_spent Type: Number Title: Total Spent Read only: true The total spent for a campaign. Calculated as the sum of all order totals with no deductions.
      total_revenue Type: Number Title: Total Revenue Read only: true The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.
      delivery_status Type: Object Title: Campaign Delivery Status Read only: false Updates on campaigns in the process of sending.
      Show properties
      enabled Type: Boolean Title: Delivery Status Enabled Read only: true Whether Campaign Delivery Status is enabled for this account and campaign.
      can_cancel Type: Boolean Title: Campaign Cancelable Read only: true Whether a campaign send can be canceled.
      status Type: String Title: Campaign Delivery Status Read only: true The current state of a campaign delivery.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails confirmed sent for this campaign so far.
      emails_canceled Type: Integer Title: Emails Canceled Read only: true The total number of emails canceled for this campaign.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1657
      Vary: Accept-Encoding
      X-Request-Id: 6442eb20-6117-460c-95f2-3c05cdf3fb72
      Link: <https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json>; rel="describedBy", <https://usX.admin.mailchimp.com/campaigns/show?id=2181921>; rel="dashboard"
      Date: Tue, 15 Sep 2015 18:05:24 GMT
      Connection: keep-alive
      
      
      {
        "id": "42694e9e57",
        "type": "regular",
        "create_time": "2015-09-15T14:40:36+00:00",
        "archive_url": "http://eepurl.com/xxxx",
        "status": "save",
        "emails_sent": 0,
        "send_time": "",
        "content_type": "template",
        "recipients": {
          "list_id": "57afe96172",
          "segment_text": ""
        },
        "settings": {
          "subject_line": "I have a rice crispy treat watermelon farm.",
          "title": "Freddie's Jokes Vol. 1",
          "from_name": "Freddie",
          "reply_to": "freddie@freddiesjokes.com",
          "use_conversation": false,
          "to_name": "",
          "folder_id": 0,
          "authenticate": true,
          "auto_footer": false,
          "inline_css": false,
          "auto_tweet": false,
          "fb_comments": false,
          "timewarp": false,
          "template_id": 100,
          "drag_and_drop": true
        },
        "tracking": {
          "opens": true,
          "html_clicks": true,
          "text_clicks": false,
          "goal_tracking": true,
          "ecomm360": true,
          "google_analytics": true,
          "clicktale": ""
        },
        "delivery_status": {
          "enabled": false
        },
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57",
            "method": "DELETE"
          },
          {
            "rel": "cancel_send",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57/actions/cancel-send",
            "method": "POST"
          },
          {
            "rel": "feedback",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57/feedback",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Feedback/Collection.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • PATCH /campaigns/{campaign_id} Update the settings for a campaign

      Update the settings for a campaign

      PATCH /campaigns/{campaign_id}

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

      Path parameters

      campaign_id The unique id for the campaign.

      Request body parameters

      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options. Update an existing campaign with an empty segment_opts object to remove any segments from that campaign’s recipient settings.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment. To remove a saved segment from the campaign, you can set this to 0 and/or change the match and conditions. If given a non-zero number, the campaign will be updated to use the given saved segment, ignoring the provided match and conditions.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Conditions Read only: false Segment match conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      settings Type: Object Title: Campaign Settings Read only: false The settings for your campaign, including subject, from name, reply-to address, and more.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      preview_text Type: String Title: Campaign Preview Text Read only: false The preview text for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      use_conversation Type: Boolean Title: Conversation Read only: false Use MailChimp Conversation feature to manage out-of-office replies.
      to_name Type: String Title: To Name Read only: false The campaign’s custom ‘To’ name. Typically the first name merge field.
      folder_id Type: String Title: Folder ID Read only: false If the campaign is listed in a folder, the id for that folder.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      template_id Type: Integer Title: Template ID Read only: false The id of the template to use.
      variate_settings Type: Object Title: A/B Test Options Read only: false The settings specific to A/B test campaigns.
      Show properties
      winner_criteria Type: String Title: Winning Criteria Read only: false The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue—or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with ‘manual’ as the winner_criteria, the winner must be chosen in the MailChimp web application.
      Possible Values:
      • opens
      • clicks
      • manual
      • total_revenue
      wait_time Type: Integer Title: Wait Time Read only: false The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes.
      test_size Type: Integer Title: Test Size Read only: false The percentage of recipients to send the test combinations to, must be a value between 10 and 100.
      subject_lines Type: Array Title: Subject Lines Read only: false The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.
      send_times Type: Array Title: Send Times Read only: false The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.
      from_names Type: Array Title: From Names Read only: false The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.
      reply_to_addresses Type: Array Title: Reply To Addresses Read only: false The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for ClickTale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      rss_opts Type: Object Title: RSS Options Read only: false RSS options for a campaign.
      Show properties
      feed_url Type: String Title: Feed URL Read only: false The URL for the RSS feed.
      frequency Type: String Title: Frequency Read only: false The frequency of the RSS Campaign.
      Possible Values:
      • daily
      • weekly
      • monthly
      schedule Type: Object Title: Sending Schedule Read only: false The schedule for sending the RSS Campaign.
      Show properties
      hour Type: Integer Title: Sending Hour Read only: false The hour to send the campaign in local time. Acceptable hours are 0-23. For example, ‘4’ would be 4am in your account’s default time zone.
      daily_send Type: Object Title: Daily Sending Days Read only: false The days of the week to send a daily RSS Campaign.
      Show properties
      sunday Type: Boolean Title: Sunday Read only: false Sends the daily RSS Campaign on Sundays.
      monday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Mondays.
      tuesday Type: Boolean Title: tuesday Read only: false Sends the daily RSS Campaign on Tuesdays.
      wednesday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Wednesdays.
      thursday Type: Boolean Title: Thursday Read only: false Sends the daily RSS Campaign on Thursdays.
      friday Type: Boolean Title: Friday Read only: false Sends the daily RSS Campaign on Fridays.
      saturday Type: Boolean Title: Saturday Read only: false Sends the daily RSS Campaign on Saturdays.
      weekly_send_day Type: String Title: Weekly Sending Day Read only: false The day of the week to send a weekly RSS Campaign.
      Possible Values:
      • sunday
      • monday
      • tuesday
      • wednesday
      • thursday
      • friday
      • saturday
      monthly_send_date Type: Number Title: Monthly Sending Day Read only: false The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where ‘0’ is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February.
      constrain_rss_img Type: Boolean Title: Constrain RSS Images Read only: false Whether to add CSS to images in the RSS feed to constrain their width in campaigns.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.

      Response body parameters

      id Type: String Title: Campaign ID Read only: true A string that uniquely identifies this campaign.
      web_id Type: Integer Title: Campaign Web ID Read only: true 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}.
      type Type: String Title: Campaign Type Read only: false 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.
      Possible Values:
      • regular
      • plaintext
      • absplit
      • rss
      • variate
      create_time Type: String Title: Create Time Read only: true The date and time the campaign was created.
      archive_url Type: String Title: Archive URL Read only: true The link to the campaign’s archive version.
      long_archive_url Type: String Title: Long Archive URL Read only: true The original link to the campaign’s archive version.
      status Type: String Title: Campaign Status Read only: true The current status of the campaign.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails sent for this campaign.
      send_time Type: String Title: Send Time Read only: true The date and time a campaign was sent.
      content_type Type: String Title: Content Type Read only: true How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
      needs_block_refresh Type: Boolean Title: Needs Block Refresh Read only: false Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor.
      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      list_name Type: String Title: List Name Read only: true The name of the list.
      segment_text Type: String Title: Segment Text Read only: true A description of the segment used for the campaign. Formatted as a string marked up with HTML.
      recipient_count Type: Integer Title: Recipient Count Read only: true Count of the recipients on the associated list. Formatted as an integer.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options. This object should contain a saved_segment_id to use an existing segment, or you can create a new segment by including both match and conditions options.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Conditions Read only: false Segment match conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      settings Type: Object Title: Campaign Settings Read only: false The settings for your campaign, including subject, from name, reply-to address, and more.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      preview_text Type: String Title: Campaign Preview Text Read only: false The preview text for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      use_conversation Type: Boolean Title: Conversation Read only: false Use MailChimp Conversation feature to manage out-of-office replies.
      to_name Type: String Title: To Name Read only: false The campaign’s custom ‘To’ name. Typically the first name merge field.
      folder_id Type: String Title: Folder ID Read only: false If the campaign is listed in a folder, the id for that folder.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      timewarp Type: Boolean Title: Timewarp Send Read only: true Send this campaign using Timewarp.
      template_id Type: Integer Title: Template ID Read only: false The id for the template used in this campaign.
      drag_and_drop Type: Boolean Title: Drag And Drop Campaign Read only: true Whether the campaign uses the drag-and-drop editor.
      variate_settings Type: Object Title: A/B Test Options Read only: false The settings specific to A/B test campaigns.
      Show properties
      winning_combination_id Type: String Title: Winning Combination ID Read only: true ID for the winning combination.
      winning_campaign_id Type: String Title: Winning Campaign ID Read only: true ID of the campaign that was sent to the remaining recipients based on the winning combination.
      winner_criteria Type: String Title: Winning Criteria Read only: false The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue—or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with ‘manual’ as the winner_criteria, the winner must be chosen in the MailChimp web application.
      Possible Values:
      • opens
      • clicks
      • manual
      • total_revenue
      wait_time Type: Integer Title: Wait Time Read only: false The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes.
      test_size Type: Integer Title: Test Size Read only: false The percentage of recipients to send the test combinations to, must be a value between 10 and 100.
      subject_lines Type: Array Title: Subject Lines Read only: false The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.
      send_times Type: Array Title: Send Times Read only: false The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.
      from_names Type: Array Title: From Names Read only: false The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.
      reply_to_addresses Type: Array Title: Reply To Addresses Read only: false The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.
      contents Type: Array Title: Content Descriptions Read only: true Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field ‘variate_contents’.
      combinations Type: Array Title: Combinations Read only: true Combinations of possible variables used to build emails.
      Show properties
      id Type: String Title: ID Read only: false Unique ID for the combination.
      subject_line Type: Integer Title: Subject Line Read only: false The index of variate_settings.subject_lines used.
      send_time Type: Integer Title: Send Time Read only: false The index of variate_settings.send_times used.
      from_name Type: Integer Title: From Name Read only: false The index of variate_settings.from_names used.
      reply_to Type: Integer Title: Reply To Read only: false The index of variate_settings.reply_to_addresses used.
      content_description Type: Integer Title: Content Description Read only: false The index of variate_settings.contents used.
      recipients Type: Integer Title: Recipients Read only: false The number of recipients for this combination.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for ClickTale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      rss_opts Type: Object Title: RSS Options Read only: false RSS options for a campaign.
      Show properties
      feed_url Type: String Title: Feed URL Read only: false The URL for the RSS feed.
      frequency Type: String Title: Frequency Read only: false The frequency of the RSS Campaign.
      Possible Values:
      • daily
      • weekly
      • monthly
      schedule Type: Object Title: Sending Schedule Read only: false The schedule for sending the RSS Campaign.
      Show properties
      hour Type: Integer Title: Sending Hour Read only: false The hour to send the campaign in local time. Acceptable hours are 0-23. For example, ‘4’ would be 4am in your account’s default time zone.
      daily_send Type: Object Title: Daily Sending Days Read only: false The days of the week to send a daily RSS Campaign.
      Show properties
      sunday Type: Boolean Title: Sunday Read only: false Sends the daily RSS Campaign on Sundays.
      monday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Mondays.
      tuesday Type: Boolean Title: tuesday Read only: false Sends the daily RSS Campaign on Tuesdays.
      wednesday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Wednesdays.
      thursday Type: Boolean Title: Thursday Read only: false Sends the daily RSS Campaign on Thursdays.
      friday Type: Boolean Title: Friday Read only: false Sends the daily RSS Campaign on Fridays.
      saturday Type: Boolean Title: Saturday Read only: false Sends the daily RSS Campaign on Saturdays.
      weekly_send_day Type: String Title: Weekly Sending Day Read only: false The day of the week to send a weekly RSS Campaign.
      Possible Values:
      • sunday
      • monday
      • tuesday
      • wednesday
      • thursday
      • friday
      • saturday
      monthly_send_date Type: Number Title: Monthly Sending Day Read only: false The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where ‘0’ is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February.
      last_sent Type: String Title: Last Sent Read only: true The date the campaign was last sent.
      constrain_rss_img Type: Boolean Title: Constrain RSS Images Read only: false Whether to add CSS to images in the RSS feed to constrain their width in campaigns.
      ab_split_opts Type: Object Title: A/B Testing Options Read only: true A/B Testing options for a campaign.
      Show properties
      split_test Type: String Title: Split Test Read only: false The type of AB split to run.
      Possible Values:
      • subject
      • from_name
      • schedule
      pick_winner Type: String Title: Pick Winner Read only: false How we should evaluate a winner. Based on ‘opens’, ‘clicks’, or ‘manual’.
      Possible Values:
      • opens
      • clicks
      • manual
      wait_units Type: String Title: Wait Time Read only: false How unit of time for measuring the winner (‘hours’ or ‘days’). This cannot be changed after a campaign is sent.
      Possible Values:
      • hours
      • days
      wait_time Type: Integer Title: Wait Time Read only: false The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent.
      split_size Type: Integer Title: Split Size Read only: false The size of the split groups. Campaigns split based on ‘schedule’ are forced to have a 5050 split. Valid split integers are between 1-50.
      from_name_a Type: String Title: From Name Group A Read only: false For campaigns split on ‘From Name’, the name for Group A.
      from_name_b Type: String Title: From Name Group B Read only: false For campaigns split on ‘From Name’, the name for Group B.
      reply_email_a Type: String Title: Reply Email Group A Read only: false For campaigns split on ‘From Name’, the reply-to address for Group A.
      reply_email_b Type: String Title: Reply Email Group B Read only: false For campaigns split on ‘From Name’, the reply-to address for Group B.
      subject_a Type: String Title: Subject Line Group A Read only: false For campaigns split on ‘Subject Line’, the subject line for Group A.
      subject_b Type: String Title: Subject Line Group B Read only: false For campaigns split on ‘Subject Line’, the subject line for Group B.
      send_time_a Type: String Title: Send Time Group A Read only: false The send time for Group A.
      send_time_b Type: String Title: Send Time Group B Read only: false The send time for Group B.
      send_time_winner Type: String Title: Send Time Winner Read only: false The send time for the winning version.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.
      report_summary Type: Object Title: Campaign Report Summary Read only: false For sent campaigns, a summary of opens, clicks, and e-commerce data.
      Show properties
      opens Type: Integer Title: Automation Opens Read only: true The total number of opens for a campaign.
      unique_opens Type: Integer Title: Unique Opens Read only: true The number of unique opens.
      open_rate Type: Number Title: Open Rate Read only: true The number of unique opens divided by the total number of successful deliveries.
      clicks Type: Integer Title: Total Clicks Read only: true The total number of clicks for an campaign.
      subscriber_clicks Type: Integer Title: Unique Subscriber Clicks Read only: true The number of unique clicks.
      click_rate Type: Number Title: Click Rate Read only: true The number of unique clicks divided by the total number of successful deliveries.
      ecommerce Type: Object Title: E-Commerce Report Read only: false E-Commerce stats for a campaign.
      Show properties
      total_orders Type: Integer Title: Total Orders Read only: true The total orders for a campaign.
      total_spent Type: Number Title: Total Spent Read only: true The total spent for a campaign. Calculated as the sum of all order totals with no deductions.
      total_revenue Type: Number Title: Total Revenue Read only: true The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.
      delivery_status Type: Object Title: Campaign Delivery Status Read only: false Updates on campaigns in the process of sending.
      Show properties
      enabled Type: Boolean Title: Delivery Status Enabled Read only: true Whether Campaign Delivery Status is enabled for this account and campaign.
      can_cancel Type: Boolean Title: Campaign Cancelable Read only: true Whether a campaign send can be canceled.
      status Type: String Title: Campaign Delivery Status Read only: true The current state of a campaign delivery.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails confirmed sent for this campaign so far.
      emails_canceled Type: Integer Title: Emails Canceled Read only: true The total number of emails canceled for this campaign.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request PATCH \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"recipients":{"list_id":"3c307a9f3f"},"type":"regular","settings":{"subject_line":"This is an updated subject line","reply_to":"orders@mammothhouse.com","from_name":"Customer Service"}}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2150
      Vary: Accept-Encoding
      X-Request-Id: 80ae6ee7-f5d8-4a78-b2e5-449e551d0854
      Link: <https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json>; rel="describedBy", <https://usX.admin.mailchimp.com/campaigns/show?id=2209445>; rel="dashboard"
      Date: Fri, 20 Nov 2015 22:10:22 GMT
      Connection: keep-alive
      
      {
        "id": "3e06f4ec92",
        "type": "regular",
        "create_time": "2015-11-20T22:06:56+00:00",
        "archive_url": "http://eepurl.com/XXXX",
        "status": "save",
        "emails_sent": 0,
        "send_time": "",
        "content_type": "template",
        "recipients": {
          "list_id": "3c307a9f3f",
          "segment_text": ""
        },
        "settings": {
          "subject_line": "This is an updated subject line",
          "title": "",
          "from_name": "Customer Service",
          "reply_to": "orders@mammothhouse.com",
          "use_conversation": false,
          "to_name": "",
          "folder_id": "",
          "authenticate": true,
          "auto_footer": false,
          "inline_css": false,
          "auto_tweet": false,
          "fb_comments": true,
          "timewarp": false,
          "template_id": 0,
          "drag_and_drop": false
        },
        "tracking": {
          "opens": true,
          "html_clicks": true,
          "text_clicks": false,
          "goal_tracking": false,
          "ecomm360": false,
          "google_analytics": "",
          "clicktale": "N"
        },
        "delivery_status": {
          "enabled": false
        },
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92",
            "method": "DELETE"
          },
          {
            "rel": "send",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/actions/send",
            "method": "POST"
          },
          {
            "rel": "cancel_send",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/actions/cancel-send",
            "method": "POST"
          },
          {
            "rel": "feedback",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/feedback",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Feedback/Collection.json"
          },
          {
            "rel": "content",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/content",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Content/Collection.json"
          },
          {
            "rel": "send_checklist",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/send-checklist",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Checklist/Collection.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • Delete a campaign

      DELETE /campaigns/{campaign_id}

      Remove a campaign from your MailChimp account.

      Path parameters

      campaign_id The unique id for the campaign.

      Example request

      
      curl --request DELETE \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2
      X-Request-Id: a8b65c06-a701-4b66-aefc-70e224e615c2
      Date: Tue, 15 Sep 2015 18:28:48 GMT
      Connection: keep-alive
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • Cancel a campaign

      POST /campaigns/{campaign_id}/actions/cancel-send

      Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with MailChimp Pro.

      Path parameters

      campaign_id The unique id for the campaign.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/67d0d46c87/actions/cancel-send' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2
      X-Request-Id: a8b65c06-a701-4b66-aefc-70e224e615eb3
      Date: Fr, 20 Nov 2015 18:28:48 GMT
      Connection: keep-alive
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Pause an RSS-Driven campaign

      POST /campaigns/{campaign_id}/actions/pause

      Pause an RSS-Driven campaign.

      Path parameters

      campaign_id The unique id for the campaign.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/c9ce47c75d/actions/pause' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Thu, 04 Feb 2016 18:29:37 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: bd43e2e3-023d-4f6a-9716-b36d67a720b9
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Replicate a campaign

      POST /campaigns/{campaign_id}/actions/replicate

      Replicate a campaign in saved or send status.

      Path parameters

      campaign_id The unique id for the campaign.

      Response body parameters

      id Type: String Title: Campaign ID Read only: true A string that uniquely identifies this campaign.
      web_id Type: Integer Title: Campaign Web ID Read only: true 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}.
      type Type: String Title: Campaign Type Read only: false 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.
      Possible Values:
      • regular
      • plaintext
      • absplit
      • rss
      • variate
      create_time Type: String Title: Create Time Read only: true The date and time the campaign was created.
      archive_url Type: String Title: Archive URL Read only: true The link to the campaign’s archive version.
      long_archive_url Type: String Title: Long Archive URL Read only: true The original link to the campaign’s archive version.
      status Type: String Title: Campaign Status Read only: true The current status of the campaign.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails sent for this campaign.
      send_time Type: String Title: Send Time Read only: true The date and time a campaign was sent.
      content_type Type: String Title: Content Type Read only: true How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
      needs_block_refresh Type: Boolean Title: Needs Block Refresh Read only: false Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor.
      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      list_name Type: String Title: List Name Read only: true The name of the list.
      segment_text Type: String Title: Segment Text Read only: true A description of the segment used for the campaign. Formatted as a string marked up with HTML.
      recipient_count Type: Integer Title: Recipient Count Read only: true Count of the recipients on the associated list. Formatted as an integer.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options. This object should contain a saved_segment_id to use an existing segment, or you can create a new segment by including both match and conditions options.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Conditions Read only: false Segment match conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      settings Type: Object Title: Campaign Settings Read only: false The settings for your campaign, including subject, from name, reply-to address, and more.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      preview_text Type: String Title: Campaign Preview Text Read only: false The preview text for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      use_conversation Type: Boolean Title: Conversation Read only: false Use MailChimp Conversation feature to manage out-of-office replies.
      to_name Type: String Title: To Name Read only: false The campaign’s custom ‘To’ name. Typically the first name merge field.
      folder_id Type: String Title: Folder ID Read only: false If the campaign is listed in a folder, the id for that folder.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      timewarp Type: Boolean Title: Timewarp Send Read only: true Send this campaign using Timewarp.
      template_id Type: Integer Title: Template ID Read only: true The id for the template used in this campaign.
      drag_and_drop Type: Boolean Title: Drag And Drop Campaign Read only: true Whether the campaign uses the drag-and-drop editor.
      variate_settings Type: Object Title: A/B Test Options Read only: false The settings specific to A/B test campaigns.
      Show properties
      winning_combination_id Type: String Title: Winning Combination ID Read only: true ID for the winning combination.
      winning_campaign_id Type: String Title: Winning Campaign ID Read only: true ID of the campaign that was sent to the remaining recipients based on the winning combination.
      winner_criteria Type: String Title: Winning Criteria Read only: false The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue—or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with ‘manual’ as the winner_criteria, the winner must be chosen in the MailChimp web application.
      Possible Values:
      • opens
      • clicks
      • manual
      • total_revenue
      wait_time Type: Integer Title: Wait Time Read only: false The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes.
      test_size Type: Integer Title: Test Size Read only: false The percentage of recipients to send the test combinations to, must be a value between 10 and 100.
      subject_lines Type: Array Title: Subject Lines Read only: false The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.
      send_times Type: Array Title: Send Times Read only: false The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.
      from_names Type: Array Title: From Names Read only: false The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.
      reply_to_addresses Type: Array Title: Reply To Addresses Read only: false The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.
      contents Type: Array Title: Content Descriptions Read only: true Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field ‘variate_contents’.
      combinations Type: Array Title: Combinations Read only: true Combinations of possible variables used to build emails.
      Show properties
      id Type: String Title: ID Read only: false Unique ID for the combination.
      subject_line Type: Integer Title: Subject Line Read only: false The index of variate_settings.subject_lines used.
      send_time Type: Integer Title: Send Time Read only: false The index of variate_settings.send_times used.
      from_name Type: Integer Title: From Name Read only: false The index of variate_settings.from_names used.
      reply_to Type: Integer Title: Reply To Read only: false The index of variate_settings.reply_to_addresses used.
      content_description Type: Integer Title: Content Description Read only: false The index of variate_settings.contents used.
      recipients Type: Integer Title: Recipients Read only: false The number of recipients for this combination.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for ClickTale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on subscriber email addresses.
      rss_opts Type: Object Title: RSS Options Read only: false RSS options for a campaign.
      Show properties
      feed_url Type: String Title: Feed URL Read only: false The URL for the RSS feed.
      frequency Type: String Title: Frequency Read only: false The frequency of the RSS Campaign.
      Possible Values:
      • daily
      • weekly
      • monthly
      schedule Type: Object Title: Sending Schedule Read only: false The schedule for sending the RSS Campaign.
      Show properties
      hour Type: Integer Title: Sending Hour Read only: false The hour to send the campaign in local time. Acceptable hours are 0-23. For example, ‘4’ would be 4am in your account’s default time zone.
      daily_send Type: Object Title: Daily Sending Days Read only: false The days of the week to send a daily RSS Campaign.
      Show properties
      sunday Type: Boolean Title: Sunday Read only: false Sends the daily RSS Campaign on Sundays.
      monday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Mondays.
      tuesday Type: Boolean Title: tuesday Read only: false Sends the daily RSS Campaign on Tuesdays.
      wednesday Type: Boolean Title: Monday Read only: false Sends the daily RSS Campaign on Wednesdays.
      thursday Type: Boolean Title: Thursday Read only: false Sends the daily RSS Campaign on Thursdays.
      friday Type: Boolean Title: Friday Read only: false Sends the daily RSS Campaign on Fridays.
      saturday Type: Boolean Title: Saturday Read only: false Sends the daily RSS Campaign on Saturdays.
      weekly_send_day Type: String Title: Weekly Sending Day Read only: false The day of the week to send a weekly RSS Campaign.
      Possible Values:
      • sunday
      • monday
      • tuesday
      • wednesday
      • thursday
      • friday
      • saturday
      monthly_send_date Type: Number Title: Monthly Sending Day Read only: false The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where ‘0’ is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February.
      last_sent Type: String Title: Last Sent Read only: true The date the campaign was last sent.
      constrain_rss_img Type: Boolean Title: Constrain RSS Images Read only: false Whether to add CSS to images in the RSS feed to constrain their width in campaigns.
      ab_split_opts Type: Object Title: A/B Testing Options Read only: true A/B Testing options for a campaign.
      Show properties
      split_test Type: String Title: Split Test Read only: false The type of AB split to run.
      Possible Values:
      • subject
      • from_name
      • schedule
      pick_winner Type: String Title: Pick Winner Read only: false How we should evaluate a winner. Based on ‘opens’, ‘clicks’, or ‘manual’.
      Possible Values:
      • opens
      • clicks
      • manual
      wait_units Type: String Title: Wait Time Read only: false How unit of time for measuring the winner (‘hours’ or ‘days’). This cannot be changed after a campaign is sent.
      Possible Values:
      • hours
      • days
      wait_time Type: Integer Title: Wait Time Read only: false The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent.
      split_size Type: Integer Title: Split Size Read only: false The size of the split groups. Campaigns split based on ‘schedule’ are forced to have a 5050 split. Valid split integers are between 1-50.
      from_name_a Type: String Title: From Name Group A Read only: false For campaigns split on ‘From Name’, the name for Group A.
      from_name_b Type: String Title: From Name Group B Read only: false For campaigns split on ‘From Name’, the name for Group B.
      reply_email_a Type: String Title: Reply Email Group A Read only: false For campaigns split on ‘From Name’, the reply-to address for Group A.
      reply_email_b Type: String Title: Reply Email Group B Read only: false For campaigns split on ‘From Name’, the reply-to address for Group B.
      subject_a Type: String Title: Subject Line Group A Read only: false For campaigns split on ‘Subject Line’, the subject line for Group A.
      subject_b Type: String Title: Subject Line Group B Read only: false For campaigns split on ‘Subject Line’, the subject line for Group B.
      send_time_a Type: String Title: Send Time Group A Read only: false The send time for Group A.
      send_time_b Type: String Title: Send Time Group B Read only: false The send time for Group B.
      send_time_winner Type: String Title: Send Time Winner Read only: false The send time for the winning version.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.
      report_summary Type: Object Title: Campaign Report Summary Read only: false For sent campaigns, a summary of opens, clicks, and unsubscribes.
      Show properties
      opens Type: Integer Title: Automation Opens Read only: true The total number of opens for a campaign.
      unique_opens Type: Integer Title: Unique Opens Read only: true The number of unique opens.
      open_rate Type: Number Title: Open Rate Read only: true The number of unique opens divided by the total number of successful deliveries.
      clicks Type: Integer Title: Total Clicks Read only: true The total number of clicks for an campaign.
      subscriber_clicks Type: Integer Title: Unique Subscriber Clicks Read only: true The number of unique clicks.
      click_rate Type: Number Title: Click Rate Read only: true The number of unique clicks divided by the total number of successful deliveries.
      ecommerce Type: Object Title: E-Commerce Report Read only: false E-Commerce stats for a campaign.
      Show properties
      total_orders Type: Integer Title: Total Orders Read only: true The total orders for a campaign.
      total_spent Type: Number Title: Total Spent Read only: true The total spent for a campaign. Calculated as the sum of all order totals with no deductions.
      total_revenue Type: Number Title: Total Revenue Read only: true The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.
      delivery_status Type: Object Title: Campaign Delivery Status Read only: false Updates on campaigns in the process of sending.
      Show properties
      enabled Type: Boolean Title: Delivery Status Enabled Read only: true Whether Campaign Delivery Status is enabled for this account and campaign.
      can_cancel Type: Boolean Title: Campaign Cancelable Read only: true Whether a campaign send can be canceled.
      status Type: String Title: Campaign Delivery Status Read only: true The current state of a campaign delivery.
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails confirmed sent for this campaign so far.
      emails_canceled Type: Integer Title: Emails Canceled Read only: true The total number of emails canceled for this campaign.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/b03bfc273a/actions/replicate' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Thu, 04 Feb 2016 18:51:29 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2399
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 963d735c-5522-4d9e-85c3-6aaca345c908
      Link: <https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json>; rel="describedBy", <https://usX.admin.mailchimp.com/campaigns/show?id=2266097>; rel="dashboard"
      
      {
        "id": "e062c5fc96",
        "type": "regular",
        "create_time": "2016-02-04T18:51:29+00:00",
        "archive_url": "http://eepurl.com/xxxx",
        "status": "save",
        "emails_sent": 0,
        "send_time": "",
        "content_type": "template",
        "recipients": {
          "list_id": "205d96e6b4",
          "segment_text": ""
        },
        "settings": {
          "subject_line": "Freddie's Joke of the Day",
          "title": "Daily Joke (copy 01)",
          "from_name": "Freddie",
          "reply_to": "freddie@mailchimp.com",
          "use_conversation": false,
          "to_name": "",
          "folder_id": "",
          "authenticate": true,
          "fb_comments": false,
          "template_id": 265037,
          "drag_and_drop": false
        },
        "tracking": {
          "opens": true,
          "html_clicks": true,
          "text_clicks": true,
          "ecomm360": true,
          "google_analytics": "",
          "clicktale": ""
        },
        "delivery_status": {
          "enabled": false
        },
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96",
            "method": "DELETE"
          },
          {
            "rel": "send",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96/actions/send",
            "method": "POST"
          },
          {
            "rel": "cancel_send",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96/actions/cancel-send",
            "method": "POST"
          },
          {
            "rel": "feedback",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96/feedback",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Feedback/Collection.json"
          },
          {
            "rel": "content",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96/content",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Content/Collection.json"
          },
          {
            "rel": "send_checklist",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96/send-checklist",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Checklist/Collection.json"
          },
          {
            "rel": "pause",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96/actions/pause",
            "method": "POST"
          },
          {
            "rel": "resume",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96/actions/resume",
            "method": "POST"
          },
          {
            "rel": "replicate",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/e062c5fc96/actions/replicate",
            "method": "POST"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Resume an RSS-Driven campaign

      POST /campaigns/{campaign_id}/actions/resume

      Resume an RSS-Driven campaign.

      Path parameters

      campaign_id The unique id for the campaign.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/c9ce47c75d/actions/resume' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Thu, 04 Feb 2016 18:35:32 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: 0807acec-8531-4576-9b7c-8937698512f1
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Schedule a campaign

      POST /campaigns/{campaign_id}/actions/schedule

      Schedule a campaign for delivery. If you’re using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.

      Path parameters

      campaign_id The unique id for the campaign.

      Request body parameters

      schedule_time Type: String Title: Schedule Time Read only: false The date and time in UTC to schedule the campaign for delivery. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45).
      timewarp Type: Boolean Title: Timewarp Read only: false Choose whether the campaign should use Timewarp when sending. Campaigns scheduled with Timewarp are localized based on the recipients’ time zones. For example, a Timewarp campaign with a schedule_time of 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set to true for campaigns using Batch Delivery.
      batch_delivery Type: Object Title: Batch Delivery Read only: false Choose whether the campaign should use Batch Delivery. Cannot be set to true for campaigns using Timewarp.
      Show properties
      batch_delay Type: Integer Title: Batch Delay Read only: false The delay, in minutes, between batches.
      batch_count Type: Integer Title: Batch Count Read only: false The number of batches for the campaign send.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/b03bfc273a/actions/schedule' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"schedule_time":"2017-02-04T19:13:00+00:00","timewarp":"false","batch_delay":"false"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Thu, 04 Feb 2016 19:14:20 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: bf2cba23-d3ec-4b84-a2ee-ff691933339a
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Send a campaign

      POST /campaigns/{campaign_id}/actions/send

      Send a MailChimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.

      Path parameters

      campaign_id The unique id for the campaign.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/3e06f4ec92/actions/send' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2
      X-Request-Id: 49e73982-24d3-4e97-b79d-b41299d499aa
      Date: Fri, 20 Nov 2015 22:16:45 GMT
      Connection: keep-alive
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Send a test email

      POST /campaigns/{campaign_id}/actions/test

      Send a test email.

      Path parameters

      campaign_id The unique id for the campaign.

      Request body parameters

      test_emails Type: Array Title: Test Emails Read only: false An array of email addresses to send the test email to.
      send_type Type: String Title: Type of email to test Read only: false Choose the type of test email to send.
      Possible Values:
      • html
      • plaintext

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/b03bfc273a/actions/test' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"test_emails":["freddie.dev@freddiesjokes.com"],"send_type":"html"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Thu, 04 Feb 2016 19:54:40 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: 4b4814f4-aa1a-462d-8fe4-b2958f9e8e1d
      Expires: Thu, 19 Nov 1981 08:52:00 GMT
      Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
      Pragma: no-cache
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Unschedule a campaign

      POST /campaigns/{campaign_id}/actions/unschedule

      Unschedule a scheduled campaign that hasn’t started sending.

      Path parameters

      campaign_id The unique id for the campaign.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/b03bfc273a/actions/unschedule' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Thu, 04 Feb 2016 19:18:41 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: 3b957db5-4fe4-4d09-9757-647e013c7f74
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.