MailChimp

An array of objects, each representing a campaign

The unique list id

An object representing all segmentation options

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_critera is ignored. For Multivariate Campaigns with 'manual' as the winner_citeria, the winner must be chosen in the MailChimp web application

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

The percentage of recipients to send the test combinations to, must be a value between 10 and 100

The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used

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

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

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

Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns

Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns

Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns

Whether to enable Goal tracking

Whether to enable eCommerce360 tracking

The custom slug for Google Analytics tracking (max of 50 bytes)

The custom slug for ClickTale tracking (max of 50 bytes)

Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration

Highrise tracking options for a campaign. Must be using MailChimp’s built-in Highrise integration

Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration

The URL for the RSS feed

The frequency of the RSS Campaign

Whether to add CSS to images in the RSS feed to constrain their width in campaigns

The schedule for sending the RSS Campaign

The url for the header image for the card

A short summary of the campaign to display

The title for the card. Typically the subject line of the campaign

The id for an existing saved segment

Segment match type: Possible Values: any, all

Create a campaign in a connected Salesforce account

Update contact notes for a campaign based on subscriber email addresses

Create a campaign in a connected Highrise account

Update contact notes for a campaign based on subscriber email addresses

Update contact notes for a campaign based on subscriber email addresses

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

The days of the week to send a daily RSS Campaign.

The day of the week to send a weekly RSS Campaign

The day of the month to send a monthly RSS Campaign. Acceptable days are 1-32, 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

Sends the daily RSS Campaign on Sundays

Sends the daily RSS Campaign on Mondays

Sends the daily RSS Campaign on Tuesdays

Sends the daily RSS Campaign on Wednesdays

Sends the daily RSS Campaign on Thursdays

Sends the daily RSS Campaign on Fridays

Sends the daily RSS Campaign on Saturdays

A string that uniquely identifies this campaign

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

The date and time the campaign was created

The link to the campaign’s archive version

The link to the campaign’s archive version

The total number of emails sent for this campaign

The time and date a campaign was sent

How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’)

List settings for the campaign

Settings for the campaign

Settings for the campaign

Settings for the campaign

RSS options for a campaign

A/B Testing options for a campaign

Settings for the campaign

For sent campaigns, a summary of opens, clicks, and unsubscribes

Updates on campaigns in the process of sending

A list of link types and descriptions for the API schema documents

The subject line for the campaign

The title of the campaign

The 'from' name on the campaign (not an email address)

The reply-to email address for the campaign

Use MailChimp Conversation feature to manage out-of-office replies

The campaign's custom 'To' name. Typically the first name merge field

If the campaign is listed in a folder, the id for that folder

Whether MailChimp authenticated the campaign. Defaults to true

Automatically append MailChimp's default footer to the campaign

Automatically inline the CSS included with the campaign content

Automatically tweet a link to the campaign archive page when the campaign is sent

An array of Facebook page ids to auto-post to

Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true

The type of AB split to run

How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'

How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent

The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent

The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50

For campaigns split on 'From Name', the name for Group A

For campaigns split on 'From Name', the name for Group B

For campaigns split on ‘From Name’, the reply-to address for Group A

For campaigns split on ‘From Name’, the reply-to address for Group B

For campaigns split on ‘Subject Line’, the subject line for Group A

For campaigns split on ‘Subject Line’, the subject line for Group B

The send time for Group A

The send time for Group B

The send time for the winning version

The total number of opens for a campaign

The number of unique opens

The number of unique opens divided by the total number of successful deliveries

The total number of clicks for an campaign

The number of unique clicks

The number of unique clicks divided by the total number of successful deliveries

Whether Campaign Delivery Status is enabled for this account and campaign

Whether a campaign send can be canceled

The current state of a campaign delivery

The total number of emails confirmed sent for this campaign so far

The total number of emails canceled for this campaign

As with an HTML ‘rel’ attribute, this describes the type of link

This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action

The HTTP method that should be used when accessing the URL defined in ‘href’. (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD)

For GETs, this is a URL representing the schema that the response should conform to

For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to

The company name for the list

The street address for the list contact

The street address for the list contact

The city for the list contact

The state for the list contact

The postal or zip code for the list contact

A two-character ISO3166 country code. Defaults to US if invalid

The phone number for the list contact

The default from name for campaigns sent to this list

The default from email for campaigns sent to this list

The default subject line for campaigns sent to this list

The default language for this lists’s forms

A string that uniquely identifies this list

The name of the list

Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration

The permission reminder for the list

Whether campaigns for this list use the Archive Bar in archives by default

Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration

The email address to send subscribe notifications to

The email address to send unsubscribe notifications to

The date and time that this list was created

An auto-generated activity score for the list (0-5)

Whether the list supports multiple formats for emails.When set to true, subscribers can choose whether they want to receive HTML or plain-text emails.When set to false, subscribers will receive HTML emails, with a plain-text alternative backup

Our EepURL shortened version of this list’s subscribe form

The full version of this list’s subscribe form (host will vary)

The list’s Email Beamer address

Whether this list is public or private

Any list-specific modules installed for this list

Stats for the list. Many of these are cached for at least five minutes

A list of link types and descriptions for the API schema documents

The number of active members in the list

The number of members who have unsubscribed from the list

The number of members cleaned from the list

The number of active members in the list since the last campaign was sent

The number of members who have unsubscribed since the last campaign was sent

The number of members cleaned from the list since the last campaign was sent

The number of campaigns in any status that use this list

The date and time the last campaign was sent to this list

The number of merge vars for this list (not EMAIL, which is required)

The average number of subscriptions per month for the list(not returned if we haven’t calculated it yet)

The average number of unsubscriptions per month for the list(not returned if we haven’t calculated it yet)

The target number of subscriptions per month for the list to keep it growing(not returned if we haven’t calculated it yet)

The average open rate(a percentage represented as a number between 0 and 100) per campaign for the list(not returned if we haven’t calculated it yet)

The average click rate(a percentage represented as a number between 0 and 100) per campaign for the list(not returned if we haven’t calculated it yet)

The date and time of the last time someone subscribed to this list

The date and time of the last time someone unsubscribed from this list

An array of objects, each representing a list

The total number of items matching the query regardless of pagination

First name of the subscriber

Last name of the subscriber

The location latitude

The location longitude

The MD5 hash of the lowercase version of the list member’s email address

Email address for a subscriber

An identifier for the address across all of MailChimp

Type of email this member asked to get (‘html’ or ‘text’).

Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending

Merged fields containing User First name and last name

Stats for the list. Many of these are cached for at least five minutes

IP address the subscriber signed up from

Date and time the subscriber signed up for the list

The IP address the subscriber used to confirm their opt-in status

Date and time the subscribe confirmed their opt-in status

Star rating for this member, between 1 and 5

Date and time the member’s info was last changed

If set/detected, the subscriber’s language

VIP status for subscriber

The list member’s email client

Subscriber location information

THe most recent Note added about this member

The list id

A list of link types and descriptions for the API schema documents

The note id

The date the note was created

The author of the note

The content of the note

Total number of members that were added to the list

The total number of an existing list members whose subscription status was updated

The number email addresses that could not be added to the list or updated

An array of objects, each representing a specific list member

The list id

The total number of items matching the query regardless of pagination

An array of objects, each representing a specific list member

The MD5 hash of the lowercase version of the list member’s email address

Email address for a subscriber

An identifier for the address across all of MailChimp

Type of email this member asked to get (‘html’ or ‘text’).

Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending

Merged fields containing User First name and last name

Stats for the list. Many of these are cached for at least five minutes

IP address the subscriber signed up from

Date and time the subscriber signed up for the list

The IP address the subscriber used to confirm their opt-in status

Date and time the subscribe confirmed their opt-in status

Star rating for this member, between 1 and 5

Date and time the member’s info was last changed

If set/detected, the subscriber’s language

VIP status for subscriber

The list member’s email client

Subscriber location information

THe most recent Note added about this member

The list id

A list of link types and descriptions for the API schema documents