MailChimp
MailChimp is a SaaS service that allows businesses to manage and automate email marketing activities, including sending marketing emails, automated messages and targeted campaigns.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://mailchimp.com/ |
| Privacy policy | https://mailchimp.com/legal/privacy/ |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add member to list |
Add or update a list member |
| Get all the lists |
Find all the lists for the current user |
| List campaigns |
This operation retrieves a list of campaigns in an account |
| New Campaign (V2) |
Create a new campaign based on a Campaign Type, Recipients list and Campaign Settings (subject line, title, from_name and reply_to) (V2). |
| New Campaign [DEPRECATED] |
This action has been deprecated. Please use New Campaign (V2) instead.
|
| New List |
Create a new list in your MailChimp account |
| Remove Member from list |
Delete a member from a list. |
| Send Campaign (Preview) |
Send an existing campaign |
| Show list members |
Show all the members of a list |
| Subscribe or unsubscribe list members |
Batch subscribe or unsubscribe list members. |
| Update member information |
Update information for a specific list member. |
Add member to list
Add or update a list member
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Id
|
list_id | True | string |
The unique id for the list |
|
Email Type
|
email_type | string |
Type of email this member asked to get (‘html’ or ‘text’) |
|
|
Status
|
status | True | string |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending |
|
First Name
|
FNAME | string |
First name of the subscriber |
|
|
Last Name
|
LNAME | string |
Last name of the subscriber |
|
|
Language
|
language | string |
If set/detected, the subscriber’s language |
|
|
VIP
|
vip | boolean |
VIP status for subscriber |
|
|
Latitude
|
latitude | float |
The location latitude |
|
|
Longitude
|
longitude | float |
The location longitude |
|
|
Email Address
|
email_address | True | string |
Email address for a subscriber |
Returns
Member Result Model
- Body
- MemberResponseModel
Get all the lists
Find all the lists for the current user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Maximum Results
|
count | integer |
The number of records to return. Default value is 10. Maximum value is 1000 |
|
|
Offset
|
offset | integer |
The number of records from a collection to skip. Default value is 0. |
Returns
Response when getting lists
List campaigns
This operation retrieves a list of campaigns in an account
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Campaigns
|
campaigns | array of CampaignResponseModel |
An array of objects, each representing a campaign |
New Campaign (V2)
Create a new campaign based on a Campaign Type, Recipients list and Campaign Settings (subject line, title, from_name and reply_to) (V2).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Campaign Type
|
type | True | string |
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 |
|
List Id
|
list_id | True | string |
The unique list id |
|
Saved Segment ID
|
saved_segment_id | integer |
The id for an existing saved segment |
|
|
Match Type
|
match | string |
Segment match type: Possible Values: any, all |
|
|
Campaign Subject Line
|
subject_line | True | string |
The subject line for the campaign |
|
Title
|
title | string |
The title of the campaign |
|
|
From Name
|
from_name | True | string |
The 'from' name on the campaign (not an email address) |
|
Reply To Address
|
reply_to | True | string |
The reply-to email address for the campaign |
|
Conversation
|
use_conversation | boolean |
Use MailChimp Conversation feature to manage out-of-office replies |
|
|
To Name
|
to_name | string |
The campaign's custom 'To' name. Typically the first name merge field |
|
|
Folder ID
|
folder_id | string |
If the campaign is listed in a folder, the id for that folder |
|
|
Authentication
|
authenticate | boolean |
Whether MailChimp authenticated the campaign. Defaults to true |
|
|
Auto-Footer
|
auto_footer | boolean |
Automatically append MailChimp's default footer to the campaign |
|
|
Inline CSS
|
inline_css | boolean |
Automatically inline the CSS included with the campaign content |
|
|
Auto-Tweet
|
auto_tweet | boolean |
Automatically tweet a link to the campaign archive page when the campaign is sent |
|
|
Auto Post to Facebook
|
auto_fb_post | array of integer |
An array of Facebook page ids to auto-post to |
|
|
Facebook Comments
|
fb_comments | boolean |
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true |
|
|
Winning Criteria
|
winner_criteria | string |
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 |
|
|
Wait Time
|
wait_time | integer |
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
|
test_size | integer |
The percentage of recipients to send the test combinations to, must be a value between 10 and 100 |
|
|
Subject Lines
|
subject_lines | array of string |
The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used |
|
|
Send Times
|
send_times | array of string |
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
|
from_names | array of string |
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
|
reply_to_addresses | array of string |
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 |
|
|
Opens
|
opens | boolean |
Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns |
|
|
HTML Click Tracking
|
html_clicks | boolean |
Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns |
|
|
Plain-Text Click Tracking
|
text_clicks | boolean |
Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns |
|
|
MailChimp Goal Tracking
|
goal_tracking | boolean |
Whether to enable Goal tracking |
|
|
eCommerce360 Tracking
|
ecomm360 | boolean |
Whether to enable eCommerce360 tracking |
|
|
Google Analytics Tracking
|
google_analytics | string |
The custom slug for Google Analytics tracking (max of 50 bytes) |
|
|
ClickTale Analytics Tracking
|
clicktale | string |
The custom slug for ClickTale tracking (max of 50 bytes) |
|
|
Salesforce Campaign
|
campaign | boolean |
Create a campaign in a connected Salesforce account |
|
|
Salesforce Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
|
|
Highrise Campaign
|
campaign | boolean |
Create a campaign in a connected Highrise account |
|
|
Highrise Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
|
|
Capsule Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
|
|
Feed URL
|
feed_url | string |
The URL for the RSS feed |
|
|
Frequency
|
frequency | string |
The frequency of the RSS Campaign |
|
|
Constrain RSS Images
|
constrain_rss_img | string |
Whether to add CSS to images in the RSS feed to constrain their width in campaigns |
|
|
Sending Hour
|
hour | integer |
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 |
|
|
Sunday
|
sunday | boolean |
Sends the daily RSS Campaign on Sundays |
|
|
Monday
|
monday | boolean |
Sends the daily RSS Campaign on Mondays |
|
|
Tuesday
|
tuesday | boolean |
Sends the daily RSS Campaign on Tuesdays |
|
|
Wednesday
|
wednesday | boolean |
Sends the daily RSS Campaign on Wednesdays |
|
|
Thursday
|
thursday | boolean |
Sends the daily RSS Campaign on Thursdays |
|
|
Friday
|
friday | boolean |
Sends the daily RSS Campaign on Fridays |
|
|
Saturday
|
saturday | boolean |
Sends the daily RSS Campaign on Saturdays |
|
|
Weekly Sending Day
|
weekly_send_day | string |
The day of the week to send a weekly RSS Campaign |
|
|
Monthly Sending Day
|
monthly_send_date | float |
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 |
|
|
Image URL
|
image_url | string |
The url for the header image for the card |
|
|
Campaign Description
|
description | string |
A short summary of the campaign to display |
|
|
Title
|
title | string |
The title for the card. Typically the subject line of the campaign |
Returns
New Campaign Result Model
New Campaign [DEPRECATED]
This action has been deprecated. Please use New Campaign (V2) instead.
Create a new campaign based on a Campaign Type, Recipients list and Campaign Settings (subject line, title, from_name and reply_to)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Campaign Type
|
type | True | string |
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 |
|
List Id
|
list_id | True | string |
The unique list id |
|
Saved Segment ID
|
saved_segment_id | integer |
The id for an existing saved segment |
|
|
Match Type
|
match | string |
Segment match type: Possible Values: any, all |
|
|
Campaign Subject Line
|
subject_line | True | string |
The subject line for the campaign |
|
Title
|
title | string |
The title of the campaign |
|
|
From Name
|
from_name | True | string |
The 'from' name on the campaign (not an email address) |
|
Reply To Address
|
reply_to | True | string |
The reply-to email address for the campaign |
|
Conversation
|
use_conversation | boolean |
Use MailChimp Conversation feature to manage out-of-office replies |
|
|
To Name
|
to_name | string |
The campaign's custom 'To' name. Typically the first name merge field |
|
|
Folder ID
|
folder_id | integer |
If the campaign is listed in a folder, the id for that folder |
|
|
Authentication
|
authenticate | boolean |
Whether MailChimp authenticated the campaign. Defaults to true |
|
|
Auto-Footer
|
auto_footer | boolean |
Automatically append MailChimp's default footer to the campaign |
|
|
Inline CSS
|
inline_css | boolean |
Automatically inline the CSS included with the campaign content |
|
|
Auto-Tweet
|
auto_tweet | boolean |
Automatically tweet a link to the campaign archive page when the campaign is sent |
|
|
Auto Post to Facebook
|
auto_fb_post | array of integer |
An array of Facebook page ids to auto-post to |
|
|
Facebook Comments
|
fb_comments | boolean |
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true |
|
|
Winning Criteria
|
winner_criteria | string |
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 |
|
|
Wait Time
|
wait_time | integer |
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
|
test_size | integer |
The percentage of recipients to send the test combinations to, must be a value between 10 and 100 |
|
|
Subject Lines
|
subject_lines | array of string |
The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used |
|
|
Send Times
|
send_times | array of string |
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
|
from_names | array of string |
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
|
reply_to_addresses | array of string |
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 |
|
|
Opens
|
opens | boolean |
Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns |
|
|
HTML Click Tracking
|
html_clicks | boolean |
Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns |
|
|
Plain-Text Click Tracking
|
text_clicks | boolean |
Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns |
|
|
MailChimp Goal Tracking
|
goal_tracking | boolean |
Whether to enable Goal tracking |
|
|
eCommerce360 Tracking
|
ecomm360 | boolean |
Whether to enable eCommerce360 tracking |
|
|
Google Analytics Tracking
|
google_analytics | string |
The custom slug for Google Analytics tracking (max of 50 bytes) |
|
|
ClickTale Analytics Tracking
|
clicktale | string |
The custom slug for ClickTale tracking (max of 50 bytes) |
|
|
Salesforce Campaign
|
campaign | boolean |
Create a campaign in a connected Salesforce account |
|
|
Salesforce Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
|
|
Highrise Campaign
|
campaign | boolean |
Create a campaign in a connected Highrise account |
|
|
Highrise Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
|
|
Capsule Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
|
|
Feed URL
|
feed_url | string |
The URL for the RSS feed |
|
|
Frequency
|
frequency | string |
The frequency of the RSS Campaign |
|
|
Constrain RSS Images
|
constrain_rss_img | string |
Whether to add CSS to images in the RSS feed to constrain their width in campaigns |
|
|
Sending Hour
|
hour | integer |
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 |
|
|
Sunday
|
sunday | boolean |
Sends the daily RSS Campaign on Sundays |
|
|
Monday
|
monday | boolean |
Sends the daily RSS Campaign on Mondays |
|
|
Tuesday
|
tuesday | boolean |
Sends the daily RSS Campaign on Tuesdays |
|
|
Wednesday
|
wednesday | boolean |
Sends the daily RSS Campaign on Wednesdays |
|
|
Thursday
|
thursday | boolean |
Sends the daily RSS Campaign on Thursdays |
|
|
Friday
|
friday | boolean |
Sends the daily RSS Campaign on Fridays |
|
|
Saturday
|
saturday | boolean |
Sends the daily RSS Campaign on Saturdays |
|
|
Weekly Sending Day
|
weekly_send_day | string |
The day of the week to send a weekly RSS Campaign |
|
|
Monthly Sending Day
|
monthly_send_date | float |
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 |
|
|
Image URL
|
image_url | string |
The url for the header image for the card |
|
|
Campaign Description
|
description | string |
A short summary of the campaign to display |
|
|
Title
|
title | string |
The title for the card. Typically the subject line of the campaign |
Returns
New Campaign Result Model
New List
Create a new list in your MailChimp account
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Name
|
name | True | string |
The name of the list |
|
Company Name
|
company | True | string |
The company name for the list |
|
Address Line 1
|
address1 | True | string |
The street address for the list contact |
|
Address Line 2
|
address2 | string |
The street address for the list contact |
|
|
City
|
city | True | string |
The city for the list contact |
|
State
|
state | True | string |
The state for the list contact |
|
Postal Code
|
zip | True | string |
The postal or zip code for the list contact |
|
Country Code
|
country | True | string |
A two-character ISO3166 country code. Defaults to US if invalid |
|
Phone Number
|
phone | True | string |
The phone number for the list contact |
|
Permission Reminder
|
permission_reminder | True | string |
Text to remind people how they signed up to this list |
|
Use Archive Bar
|
use_archive_bar | boolean |
Whether campaigns for this list use the Archive Bar in archives by default |
|
|
Sender's Name
|
from_name | True | string |
The default from name for campaigns sent to this list |
|
Sender's Email Address
|
from_email | True | string |
The default from email for campaigns sent to this list |
|
Subject
|
subject | True | string |
The default subject line for campaigns sent to this list |
|
Language
|
language | True | string |
The default language for this lists’s forms |
|
Notify on Subscribe
|
notify_on_subscribe | string |
The email address to send subscribe notifications to |
|
|
Notify on Unsubscribe
|
notify_on_unsubscribe | string |
The email address to send unsubscribe notifications to |
|
|
Allow users to choose between HTML and Plain text (true/false)?
|
email_type_option | True | boolean |
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 |
|
Visibility
|
visibility | string |
Whether this list is public or private |
Returns
Create New List Result Model
Remove Member from list
Delete a member from a list.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Id
|
list_id | True | string |
The unique id for the list |
|
Member email
|
member_email | True | string |
The email address of the member to delete |
Send Campaign (Preview)
Send an existing campaign
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Campaign
|
campaign_id | True | string |
The unique id for the list |
Show list members
Show all the members of a list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Id
|
list_id | True | string |
The unique id for the list |
|
Maximum Results
|
count | integer |
The number of records to return. Default value is 10. Maximum value is 1000 |
|
|
Offset
|
offset | integer |
The number of records from a collection to skip. Default value is 0. |
Returns
Response when querying for all members in a list
Subscribe or unsubscribe list members
Batch subscribe or unsubscribe list members.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Id
|
list_id | True | string |
The unique id for the list |
|
Skip Merge Validation
|
skip_merge_validation | boolean |
Allows member data to be accepted without merge field values |
|
|
Skip Duplicate Check
|
skip_duplicate_check | boolean |
Ignores duplicates sent in the request |
|
|
Email Type
|
email_type | string |
Type of email this member asked to get (‘html’ or ‘text’) |
|
|
Status
|
status | True | string |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending |
|
First Name
|
FNAME | string |
First name of the subscriber |
|
|
Last Name
|
LNAME | string |
Last name of the subscriber |
|
|
Language
|
language | string |
If set/detected, the subscriber’s language |
|
|
VIP
|
vip | boolean |
VIP status for subscriber |
|
|
Latitude
|
latitude | float |
The location latitude |
|
|
Longitude
|
longitude | float |
The location longitude |
|
|
Email Address
|
email_address | True | string |
Email address for a subscriber |
|
Update Existing Members
|
update_existing | boolean |
Whether this batch operation will change existing members' subscription status. |
Returns
Response when subscribing or unsubscribing list members in a batch
Update member information
Update information for a specific list member.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Id
|
list_id | True | string |
The unique id for the list |
|
Member email
|
member_email | True | string |
The unique email address of the member to update |
|
Email Type
|
email_type | string |
Type of email this member asked to get (‘html’ or ‘text’) |
|
|
Status
|
status | True | string |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending |
|
First Name
|
FNAME | string |
First name of the subscriber |
|
|
Last Name
|
LNAME | string |
Last name of the subscriber |
|
|
Language
|
language | string |
If set/detected, the subscriber’s language |
|
|
VIP
|
vip | boolean |
VIP status for subscriber |
|
|
Latitude
|
latitude | float |
The location latitude |
|
|
Longitude
|
longitude | float |
The location longitude |
Returns
Member Result Model
- Body
- MemberResponseModel
Triggers
| When a Member has been added to a list |
Triggers a workflow when a new member has been added to a list |
| When a new list is created |
Triggers a workflow when a new list is created |
When a Member has been added to a list
Triggers a workflow when a new member has been added to a list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
list_id | True | string |
The unique id for the list |
Returns
Response when getting members in a list
When a new list is created
Triggers a workflow when a new list is created
Returns
Response when getting lists
Definitions
Recipient
Settings for the campaign
| Name | Path | Type | Description |
|---|---|---|---|
|
List Id
|
list_id | string |
The unique list id |
|
segment_opts
|
segment_opts | Segment_Opts |
An object representing all segmentation options |
Variate_Settings
Settings for the campaign
| Name | Path | Type | Description |
|---|---|---|---|
|
Winning Criteria
|
winner_criteria | string |
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 |
|
Wait Time
|
wait_time | integer |
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
|
test_size | integer |
The percentage of recipients to send the test combinations to, must be a value between 10 and 100 |
|
Subject Lines
|
subject_lines | array of string |
The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used |
|
Send Times
|
send_times | array of string |
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
|
from_names | array of string |
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
|
reply_to_addresses | array of string |
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 |
Tracking
Settings for the campaign
| Name | Path | Type | Description |
|---|---|---|---|
|
Opens
|
opens | boolean |
Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns |
|
HTML Click Tracking
|
html_clicks | boolean |
Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns |
|
Plain-Text Click Tracking
|
text_clicks | boolean |
Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns |
|
MailChimp Goal Tracking
|
goal_tracking | boolean |
Whether to enable Goal tracking |
|
eCommerce360 Tracking
|
ecomm360 | boolean |
Whether to enable eCommerce360 tracking |
|
Google Analytics Tracking
|
google_analytics | string |
The custom slug for Google Analytics tracking (max of 50 bytes) |
|
ClickTale Analytics Tracking
|
clicktale | string |
The custom slug for ClickTale tracking (max of 50 bytes) |
|
salesforce
|
salesforce | Salesforce |
Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration |
|
highrise
|
highrise | Highrise |
Highrise tracking options for a campaign. Must be using MailChimp’s built-in Highrise integration |
|
capsule
|
capsule | Capsule |
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration |
RSS_Opts
RSS options for a campaign
| Name | Path | Type | Description |
|---|---|---|---|
|
Feed URL
|
feed_url | string |
The URL for the RSS feed |
|
Frequency
|
frequency | string |
The frequency of the RSS Campaign |
|
Constrain RSS Images
|
constrain_rss_img | string |
Whether to add CSS to images in the RSS feed to constrain their width in campaigns |
|
schedule
|
schedule | Schedule |
The schedule for sending the RSS Campaign |
Social_Card
Settings for the campaign
| Name | Path | Type | Description |
|---|---|---|---|
|
Image URL
|
image_url | string |
The url for the header image for the card |
|
Campaign Description
|
description | string |
A short summary of the campaign to display |
|
Title
|
title | string |
The title for the card. Typically the subject line of the campaign |
Segment_Opts
An object representing all segmentation options
| Name | Path | Type | Description |
|---|---|---|---|
|
Saved Segment ID
|
saved_segment_id | integer |
The id for an existing saved segment |
|
Match Type
|
match | string |
Segment match type: Possible Values: any, all |
Salesforce
Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration
| Name | Path | Type | Description |
|---|---|---|---|
|
Salesforce Campaign
|
campaign | boolean |
Create a campaign in a connected Salesforce account |
|
Salesforce Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
Highrise
Highrise tracking options for a campaign. Must be using MailChimp’s built-in Highrise integration
| Name | Path | Type | Description |
|---|---|---|---|
|
Highrise Campaign
|
campaign | boolean |
Create a campaign in a connected Highrise account |
|
Highrise Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
Capsule
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
| Name | Path | Type | Description |
|---|---|---|---|
|
Capsule Note
|
notes | boolean |
Update contact notes for a campaign based on subscriber email addresses |
Schedule
The schedule for sending the RSS Campaign
| Name | Path | Type | Description |
|---|---|---|---|
|
Sending Hour
|
hour | integer |
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
|
daily_send | Daily_Send |
The days of the week to send a daily RSS Campaign. |
|
Weekly Sending Day
|
weekly_send_day | string |
The day of the week to send a weekly RSS Campaign |
|
Monthly Sending Day
|
monthly_send_date | float |
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 |
Daily_Send
The days of the week to send a daily RSS Campaign.
| Name | Path | Type | Description |
|---|---|---|---|
|
Sunday
|
sunday | boolean |
Sends the daily RSS Campaign on Sundays |
|
Monday
|
monday | boolean |
Sends the daily RSS Campaign on Mondays |
|
Tuesday
|
tuesday | boolean |
Sends the daily RSS Campaign on Tuesdays |
|
Wednesday
|
wednesday | boolean |
Sends the daily RSS Campaign on Wednesdays |
|
Thursday
|
thursday | boolean |
Sends the daily RSS Campaign on Thursdays |
|
Friday
|
friday | boolean |
Sends the daily RSS Campaign on Fridays |
|
Saturday
|
saturday | boolean |
Sends the daily RSS Campaign on Saturdays |
CampaignResponseModel
New Campaign Result Model
| Name | Path | Type | Description |
|---|---|---|---|
|
Campaign ID
|
id | string |
A string that uniquely identifies this campaign |
|
Campaign Type
|
type | string |
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 |
|
Created Time
|
create_time | string |
The date and time the campaign was created |
|
Archive URL
|
archive_url | string |
The link to the campaign’s archive version |
|
Status
|
status | string |
The link to the campaign’s archive version |
|
Emails Sent
|
emails_sent | integer |
The total number of emails sent for this campaign |
|
Send Time
|
send_time | string |
The time and date a campaign was sent |
|
Content Type
|
content_type | string |
How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’) |
|
List
|
recipient | array of Recipient |
List settings for the campaign |
|
settings
|
settings | SettingsV2 |
Settings for the campaign |
|
variate_settings
|
variate_settings | Variate_Settings |
Settings for the campaign |
|
tracking
|
tracking | Tracking |
Settings for the campaign |
|
rss_opts
|
rss_opts | RSS_Opts |
RSS options for a campaign |
|
ab_split_opts
|
ab_split_opts | AB_Split_Opts |
A/B Testing options for a campaign |
|
social_card
|
social_card | Social_Card |
Settings for the campaign |
|
report_summary
|
report_summary | Report_Summary |
For sent campaigns, a summary of opens, clicks, and unsubscribes |
|
delivery_status
|
delivery_status | Delivery_Status |
Updates on campaigns in the process of sending |
|
_links
|
_links | array of Link |
A list of link types and descriptions for the API schema documents |
SettingsV2
Settings for the campaign
| Name | Path | Type | Description |
|---|---|---|---|
|
Campaign Subject Line
|
subject_line | string |
The subject line for the campaign |
|
Title
|
title | string |
The title of the campaign |
|
From Name
|
from_name | string |
The 'from' name on the campaign (not an email address) |
|
Reply To Address
|
reply_to | string |
The reply-to email address for the campaign |
|
Conversation
|
use_conversation | boolean |
Use MailChimp Conversation feature to manage out-of-office replies |
|
To Name
|
to_name | string |
The campaign's custom 'To' name. Typically the first name merge field |
|
Folder ID
|
folder_id | string |
If the campaign is listed in a folder, the id for that folder |
|
Authentication
|
authenticate | boolean |
Whether MailChimp authenticated the campaign. Defaults to true |
|
Auto-Footer
|
auto_footer | boolean |
Automatically append MailChimp's default footer to the campaign |
|
Inline CSS
|
inline_css | boolean |
Automatically inline the CSS included with the campaign content |
|
Auto-Tweet
|
auto_tweet | boolean |
Automatically tweet a link to the campaign archive page when the campaign is sent |
|
Auto Post to Facebook
|
auto_fb_post | array of integer |
An array of Facebook page ids to auto-post to |
|
Facebook Comments
|
fb_comments | boolean |
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true |
AB_Split_Opts
A/B Testing options for a campaign
| Name | Path | Type | Description |
|---|---|---|---|
|
Split Test
|
split_test | string |
The type of AB split to run |
|
Pick Winner
|
pick_winner | string |
How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual' |
|
Wait Time
|
wait_units | string |
How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent |
|
Wait Time
|
wait_time | integer |
The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent |
|
Split Size
|
split_size | integer |
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 |
|
From Name Group A
|
from_name_a | string |
For campaigns split on 'From Name', the name for Group A |
|
From Name Group B
|
from_name_b | string |
For campaigns split on 'From Name', the name for Group B |
|
Reply Email Group A
|
reply_email_a | string |
For campaigns split on ‘From Name’, the reply-to address for Group A |
|
Reply Email Group B
|
reply_email_b | string |
For campaigns split on ‘From Name’, the reply-to address for Group B |
|
Subject Line Group A
|
subject_a | string |
For campaigns split on ‘Subject Line’, the subject line for Group A |
|
Subject Line Group B
|
subject_b | string |
For campaigns split on ‘Subject Line’, the subject line for Group B |
|
Send Time Group A
|
send_time_a | string |
The send time for Group A |
|
Send Time Group B
|
send_time_b | string |
The send time for Group B |
|
Send Time Winner
|
send_time_winner | string |
The send time for the winning version |
Report_Summary
For sent campaigns, a summary of opens, clicks, and unsubscribes
| Name | Path | Type | Description |
|---|---|---|---|
|
Automation Opens
|
opens | integer |
The total number of opens for a campaign |
|
Unique Opens
|
unique_opens | integer |
The number of unique opens |
|
Open Rate
|
open_rate | float |
The number of unique opens divided by the total number of successful deliveries |
|
Total Clicks
|
clicks | integer |
The total number of clicks for an campaign |
|
Unique Subscriber Clicks
|
subscriber_clicks | float |
The number of unique clicks |
|
Click Rate
|
click_rate | float |
The number of unique clicks divided by the total number of successful deliveries |
Delivery_Status
Updates on campaigns in the process of sending
| Name | Path | Type | Description |
|---|---|---|---|
|
Delivery Staut Enabled
|
enabled | boolean |
Whether Campaign Delivery Status is enabled for this account and campaign |
|
Campaign Cancelable
|
can_cancel | boolean |
Whether a campaign send can be canceled |
|
Campaign Delivery Status
|
status | string |
The current state of a campaign delivery |
|
Emails Sent
|
emails_sent | integer |
The total number of emails confirmed sent for this campaign so far |
|
Emails Canceled
|
emails_canceled | integer |
The total number of emails canceled for this campaign |
Link
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
| Name | Path | Type | Description |
|---|---|---|---|
|
Rel
|
rel | string |
As with an HTML ‘rel’ attribute, this describes the type of link |
|
Href
|
href | string |
This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action |
|
Method
|
method | string |
The HTTP method that should be used when accessing the URL defined in ‘href’. (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD) |
|
Target Schema
|
targetSchema | string |
For GETs, this is a URL representing the schema that the response should conform to |
|
Schema
|
schema | string |
For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to |
Contact
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
| Name | Path | Type | Description |
|---|---|---|---|
|
Company Name
|
company | string |
The company name for the list |
|
Address Line 1
|
address1 | string |
The street address for the list contact |
|
Address Line 2
|
address2 | string |
The street address for the list contact |
|
City
|
city | string |
The city for the list contact |
|
State
|
state | string |
The state for the list contact |
|
Postal Code
|
zip | string |
The postal or zip code for the list contact |
|
Country Code
|
country | string |
A two-character ISO3166 country code. Defaults to US if invalid |
|
Phone Number
|
phone | string |
The phone number for the list contact |
Campaign_Defaults
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
| Name | Path | Type | Description |
|---|---|---|---|
|
Sender's Name
|
from_name | string |
The default from name for campaigns sent to this list |
|
Sender's Email Address
|
from_email | string |
The default from email for campaigns sent to this list |
|
Subject
|
subject | string |
The default subject line for campaigns sent to this list |
|
Language
|
language | string |
The default language for this lists’s forms |
CreateNewListResponseModel
Create New List Result Model
| Name | Path | Type | Description |
|---|---|---|---|
|
List ID
|
id | string |
A string that uniquely identifies this list |
|
List Name
|
name | string |
The name of the list |
|
contact
|
contact | Contact |
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration |
|
Permission Reminder
|
permission_reminder | string |
The permission reminder for the list |
|
Use Archive Bar
|
use_archive_bar | boolean |
Whether campaigns for this list use the Archive Bar in archives by default |
|
campaign_defaults
|
campaign_defaults | Campaign_Defaults |
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration |
|
Notify on Subscribe
|
notify_on_subscribe | string |
The email address to send subscribe notifications to |
|
Notify on Unsubscribe
|
notify_on_unsubscribe | string |
The email address to send unsubscribe notifications to |
|
Creation Date
|
date_created | string |
The date and time that this list was created |
|
List Rating
|
list_rating | integer |
An auto-generated activity score for the list (0-5) |
|
Email Type Option
|
email_type_option | boolean |
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 |
|
Subscribe URL Short
|
subscribe_url_short | string |
Our EepURL shortened version of this list’s subscribe form |
|
Subscribe URL Long
|
subscribe_url_long | string |
The full version of this list’s subscribe form (host will vary) |
|
Beamer Address
|
beamer_address | string |
The list’s Email Beamer address |
|
Visibility
|
visibility | string |
Whether this list is public or private |
|
Modules
|
modules | array of string |
Any list-specific modules installed for this list |
|
stats
|
stats | Stats |
Stats for the list. Many of these are cached for at least five minutes |
|
Links
|
_links | array of Link |
A list of link types and descriptions for the API schema documents |
Stats
Stats for the list. Many of these are cached for at least five minutes
| Name | Path | Type | Description |
|---|---|---|---|
|
Member Count
|
member_count | integer |
The number of active members in the list |
|
Unsubscribe Count
|
unsubscribe_count | integer |
The number of members who have unsubscribed from the list |
|
Cleaned Count
|
cleaned_count | integer |
The number of members cleaned from the list |
|
Member Count Since Send
|
member_count_since_send | integer |
The number of active members in the list since the last campaign was sent |
|
Unsubscribe Count Since Send
|
unsubscribe_count_since_send | integer |
The number of members who have unsubscribed since the last campaign was sent |
|
Cleaned Count Since Send
|
cleaned_count_since_send | integer |
The number of members cleaned from the list since the last campaign was sent |
|
Campaign Count
|
campaign_count | integer |
The number of campaigns in any status that use this list |
|
Campaign Last Sent
|
campaign_last_sent | date-time |
The date and time the last campaign was sent to this list |
|
Merge Var Count
|
merge_field_count | integer |
The number of merge vars for this list (not EMAIL, which is required) |
|
Average Subscription Rate
|
avg_sub_rate | float |
The average number of subscriptions per month for the list(not returned if we haven’t calculated it yet) |
|
Average Unsubscription Rate
|
avg_unsub_rate | float |
The average number of unsubscriptions per month for the list(not returned if we haven’t calculated it yet) |
|
Target Subscription Rate
|
target_sub_rate | float |
The target number of subscriptions per month for the list to keep it growing(not returned if we haven’t calculated it yet) |
|
Open Rate
|
open_rate | float |
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) |
|
Click Rate
|
click_rate | float |
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) |
|
Date of Last List Subscribe
|
last_sub_date | string |
The date and time of the last time someone subscribed to this list |
|
Date of Last List Unsubscribe
|
last_unsub_date | string |
The date and time of the last time someone unsubscribed from this list |
GetListsResponseModel
Response when getting lists
| Name | Path | Type | Description |
|---|---|---|---|
|
Lists
|
lists | array of CreateNewListResponseModel |
An array of objects, each representing a list |
|
Item Count
|
total_items | integer |
The total number of items matching the query regardless of pagination |
FirstAndLastName
Merged fields containing User First name and last name
| Name | Path | Type | Description |
|---|---|---|---|
|
First Name
|
FNAME | string |
First name of the subscriber |
|
Last Name
|
LNAME | string |
Last name of the subscriber |
Location
Subscriber location information
| Name | Path | Type | Description |
|---|---|---|---|
|
Latitude
|
latitude | float |
The location latitude |
|
Longitude
|
longitude | float |
The location longitude |
MemberResponseModel
Member Result Model
| Name | Path | Type | Description |
|---|---|---|---|
|
Email ID
|
id | string |
The MD5 hash of the lowercase version of the list member’s email address |
|
Email Address
|
email_address | string |
Email address for a subscriber |
|
Unique Email ID
|
unique_email_id | string |
An identifier for the address across all of MailChimp |
|
Email Type
|
email_type | string |
Type of email this member asked to get (‘html’ or ‘text’). |
|
Status
|
status | string |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending |
|
merge_fields
|
merge_fields | FirstAndLastName |
Merged fields containing User First name and last name |
|
stats
|
stats | Stats |
Stats for the list. Many of these are cached for at least five minutes |
|
Signup IP
|
ip_signup | string |
IP address the subscriber signed up from |
|
Signup Timestamp
|
timestamp_signup | string |
Date and time the subscriber signed up for the list |
|
Opt-in IP
|
ip_opt | string |
The IP address the subscriber used to confirm their opt-in status |
|
Opt-in Timestamp
|
timestamp_opt | string |
Date and time the subscribe confirmed their opt-in status |
|
Member Rating
|
member_rating | integer |
Star rating for this member, between 1 and 5 |
|
Last Changed Date
|
last_changed | string |
Date and time the member’s info was last changed |
|
Language
|
language | string |
If set/detected, the subscriber’s language |
|
VIP
|
vip | boolean |
VIP status for subscriber |
|
Email Client
|
email_client | string |
The list member’s email client |
|
location
|
location | Location |
Subscriber location information |
|
last_note
|
last_note | Last_Note |
THe most recent Note added about this member |
|
List ID
|
list_id | string |
The list id |
|
Links
|
_links | array of Link |
A list of link types and descriptions for the API schema documents |
Last_Note
THe most recent Note added about this member
| Name | Path | Type | Description |
|---|---|---|---|
|
Note ID
|
note_id | integer |
The note id |
|
Created Time
|
created_at | string |
The date the note was created |
|
Author
|
created_by | string |
The author of the note |
|
Note
|
note | string |
The content of the note |
GetAddMembersBatchResponseModel
Response when subscribing or unsubscribing list members in a batch
| Name | Path | Type | Description |
|---|---|---|---|
|
Total Created
|
total_created | integer |
Total number of members that were added to the list |
|
Total Updated
|
total_updated | integer |
The total number of an existing list members whose subscription status was updated |
|
Error Count
|
error_count | integer |
The number email addresses that could not be added to the list or updated |
GetAllMembersResponseModel
Response when querying for all members in a list
| Name | Path | Type | Description |
|---|---|---|---|
|
Members
|
members | array of MemberResponseModel |
An array of objects, each representing a specific list member |
|
List Id
|
list_id | string |
The list id |
|
Total Items
|
total_items | integer |
The total number of items matching the query regardless of pagination |
GetMembersResponseModel
Response when getting members in a list
| Name | Path | Type | Description |
|---|---|---|---|
|
Members
|
members | array of AddUserResponseModel |
An array of objects, each representing a specific list member |
AddUserResponseModel
New Campaign Result Model
| Name | Path | Type | Description |
|---|---|---|---|
|
Email ID
|
id | string |
The MD5 hash of the lowercase version of the list member’s email address |
|
Email Address
|
email_address | string |
Email address for a subscriber |
|
Unique Email ID
|
unique_email_id | string |
An identifier for the address across all of MailChimp |
|
Email Type
|
email_type | string |
Type of email this member asked to get (‘html’ or ‘text’). |
|
Status
|
status | string |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending |
|
merge_fields
|
merge_fields | FirstAndLastName |
Merged fields containing User First name and last name |
|
stats
|
stats | Stats |
Stats for the list. Many of these are cached for at least five minutes |
|
Signup IP
|
ip_signup | string |
IP address the subscriber signed up from |
|
Signup Timestamp
|
timestamp_signup | string |
Date and time the subscriber signed up for the list |
|
Opt-in IP
|
ip_opt | string |
The IP address the subscriber used to confirm their opt-in status |
|
Opt-in Timestamp
|
timestamp_opt | string |
Date and time the subscribe confirmed their opt-in status |
|
Member Rating
|
member_rating | integer |
Star rating for this member, between 1 and 5 |
|
Last Changed Date
|
last_changed | string |
Date and time the member’s info was last changed |
|
Language
|
language | string |
If set/detected, the subscriber’s language |
|
VIP
|
vip | boolean |
VIP status for subscriber |
|
Email Client
|
email_client | string |
The list member’s email client |
|
location
|
location | Location |
Subscriber location information |
|
last_note
|
last_note | Last_Note |
THe most recent Note added about this member |
|
List ID
|
list_id | string |
The list id |
|
Links
|
_links | array of Link |
A list of link types and descriptions for the API schema documents |