MailChimp

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
Flow Premium All Flow regions
PowerApps Premium All PowerApps regions

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add member to list

Add or update a list member

Required Parameters

List Id
string
The unique id for the list
Status
string
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending
Email Address
string
Email address for a subscriber

Optional Parameters

Email Type
string
Type of email this member asked to get (‘html’ or ‘text’)
First Name
string
First name of the subscriber
Last Name
string
Last name of the subscriber
Language
string
If set/detected, the subscriber’s language
VIP
boolean
VIP status for subscriber
Latitude
float
The location latitude
Longitude
float
The location longitude

Returns

Body
MemberResponseModel

Member Result Model

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

Required Parameters

Campaign 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. Possible Values: regular, plaintext, absplit, rss, variate
List Id
string
The unique list id
Campaign Subject Line
string
The subject line for the campaign
From Name
string
The 'from' name on the campaign (not an email address)
Reply To Address
string
The reply-to email address for the campaign

Optional Parameters

Saved Segment ID
integer
The id for an existing saved segment
Match Type
string
Segment match type: Possible Values: any, all
Title
string
The title of the campaign
Conversation
boolean
Use MailChimp Conversation feature to manage out-of-office replies
To Name
string
The campaign's custom 'To' name. Typically the first name merge field
Folder ID
string
If the campaign is listed in a folder, the id for that folder
Authentication
boolean
Whether MailChimp authenticated the campaign. Defaults to true
Auto-Footer
boolean
Automatically append MailChimp's default footer to the campaign
Inline CSS
boolean
Automatically inline the CSS included with the campaign content
Auto-Tweet
boolean
Automatically tweet a link to the campaign archive page when the campaign is sent
Auto Post to Facebook
integer
Facebook Comments
boolean
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true
Winning 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
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
integer
The percentage of recipients to send the test combinations to, must be a value between 10 and 100
Subject Lines
string
Send Times
string
From Names
string
Reply To Addresses
string
Opens
boolean
Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns
HTML Click Tracking
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
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
boolean
Whether to enable Goal tracking
eCommerce360 Tracking
boolean
Whether to enable eCommerce360 tracking
Google Analytics Tracking
string
The custom slug for Google Analytics tracking (max of 50 bytes)
ClickTale Analytics Tracking
string
The custom slug for ClickTale tracking (max of 50 bytes)
Salesforce Campaign
boolean
Create a campaign in a connected Salesforce account
Salesforce Note
boolean
Update contact notes for a campaign based on subscriber email addresses
Highrise Campaign
boolean
Create a campaign in a connected Highrise account
Highrise Note
boolean
Update contact notes for a campaign based on subscriber email addresses
Capsule Note
boolean
Update contact notes for a campaign based on subscriber email addresses
Feed URL
string
The URL for the RSS feed
Frequency
string
The frequency of the RSS Campaign
Constrain RSS Images
string
Whether to add CSS to images in the RSS feed to constrain their width in campaigns
Sending 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
boolean
Sends the daily RSS Campaign on Sundays
Monday
boolean
Sends the daily RSS Campaign on Mondays
Tuesday
boolean
Sends the daily RSS Campaign on Tuesdays
Wednesday
boolean
Sends the daily RSS Campaign on Wednesdays
Thursday
boolean
Sends the daily RSS Campaign on Thursdays
Friday
boolean
Sends the daily RSS Campaign on Fridays
Saturday
boolean
Sends the daily RSS Campaign on Saturdays
Weekly Sending Day
string
The day of the week to send a weekly RSS Campaign
Monthly Sending Day
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
string
The url for the header image for the card
Campaign Description
string
A short summary of the campaign to display
Title
string
The title for the card. Typically the subject line of the campaign

Returns

Body
CampaignResponseModel

New Campaign Result Model

New Campaign [DEPRECATED]

Create a new campaign based on a Campaign Type, Recipients list and Campaign Settings (subject line, title, from_name and reply_to)

Required Parameters

Campaign 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. Possible Values: regular, plaintext, absplit, rss, variate
List Id
string
The unique list id
Campaign Subject Line
string
The subject line for the campaign
From Name
string
The 'from' name on the campaign (not an email address)
Reply To Address
string
The reply-to email address for the campaign

Optional Parameters

Saved Segment ID
integer
The id for an existing saved segment
Match Type
string
Segment match type: Possible Values: any, all
Title
string
The title of the campaign
Conversation
boolean
Use MailChimp Conversation feature to manage out-of-office replies
To Name
string
The campaign's custom 'To' name. Typically the first name merge field
Folder ID
integer
If the campaign is listed in a folder, the id for that folder
Authentication
boolean
Whether MailChimp authenticated the campaign. Defaults to true
Auto-Footer
boolean
Automatically append MailChimp's default footer to the campaign
Inline CSS
boolean
Automatically inline the CSS included with the campaign content
Auto-Tweet
boolean
Automatically tweet a link to the campaign archive page when the campaign is sent
Auto Post to Facebook
integer
Facebook Comments
boolean
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true
Winning 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
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
integer
The percentage of recipients to send the test combinations to, must be a value between 10 and 100
Subject Lines
string
Send Times
string
From Names
string
Reply To Addresses
string
Opens
boolean
Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns
HTML Click Tracking
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
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
boolean
Whether to enable Goal tracking
eCommerce360 Tracking
boolean
Whether to enable eCommerce360 tracking
Google Analytics Tracking
string
The custom slug for Google Analytics tracking (max of 50 bytes)
ClickTale Analytics Tracking
string
The custom slug for ClickTale tracking (max of 50 bytes)
Salesforce Campaign
boolean
Create a campaign in a connected Salesforce account
Salesforce Note
boolean
Update contact notes for a campaign based on subscriber email addresses
Highrise Campaign
boolean
Create a campaign in a connected Highrise account
Highrise Note
boolean
Update contact notes for a campaign based on subscriber email addresses
Capsule Note
boolean
Update contact notes for a campaign based on subscriber email addresses
Feed URL
string
The URL for the RSS feed
Frequency
string
The frequency of the RSS Campaign
Constrain RSS Images
string
Whether to add CSS to images in the RSS feed to constrain their width in campaigns
Sending 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
boolean
Sends the daily RSS Campaign on Sundays
Monday
boolean
Sends the daily RSS Campaign on Mondays
Tuesday
boolean
Sends the daily RSS Campaign on Tuesdays
Wednesday
boolean
Sends the daily RSS Campaign on Wednesdays
Thursday
boolean
Sends the daily RSS Campaign on Thursdays
Friday
boolean
Sends the daily RSS Campaign on Fridays
Saturday
boolean
Sends the daily RSS Campaign on Saturdays
Weekly Sending Day
string
The day of the week to send a weekly RSS Campaign
Monthly Sending Day
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
string
The url for the header image for the card
Campaign Description
string
A short summary of the campaign to display
Title
string
The title for the card. Typically the subject line of the campaign

Returns

Body
CampaignResponseModel

New Campaign Result Model

New List

Create a new list in your MailChimp account

Required Parameters

List Name
string
The name of the list
Company Name
string
The company name for the list
Address Line 1
string
The street address for the list contact
City
string
The city for the list contact
State
string
The state for the list contact
Postal Code
string
The postal or zip code for the list contact
Country Code
string
A two-character ISO3166 country code. Defaults to US if invalid
Phone Number
string
The phone number for the list contact
Permission Reminder
string
Text to remind people how they signed up to this list
Sender's Name
string
The default from name for campaigns sent to this list
Sender's Email Address
string
The default from email for campaigns sent to this list
Subject
string
The default subject line for campaigns sent to this list
Language
string
The default language for this lists’s forms
Allow users to choose between HTML and Plain text (true/false)?
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

Optional Parameters

Address Line 2
string
The street address for the list contact
Use Archive Bar
boolean
Whether campaigns for this list use the Archive Bar in archives by default
Notify on Subscribe
string
The email address to send subscribe notifications to
Notify on Unsubscribe
string
The email address to send unsubscribe notifications to
Visibility
string
Whether this list is public or private

Returns

Body
CreateNewListResponseModel

Create New List Result Model

Remove Member from list

Delete a member from a list.

Required Parameters

List Id
string
The unique id for the list
Member email
string
The email address of the member to delete

Returns

Body
MemberResponseModel

Member Result Model

Update member information

Update information for a specific list member.

Required Parameters

List Id
string
The unique id for the list
Member email
string
The unique email address of the member to update
Status
string
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending

Optional Parameters

Email Type
string
Type of email this member asked to get (‘html’ or ‘text’)
First Name
string
First name of the subscriber
Last Name
string
Last name of the subscriber
Language
string
If set/detected, the subscriber’s language
VIP
boolean
VIP status for subscriber
Latitude
float
The location latitude
Longitude
float
The location longitude

Returns

Body
MemberResponseModel

Member Result Model

Triggers

When a Member has been added to a list

Triggers a workflow when a new member has been added to a list

Required Parameters

List ID
string
The unique id for the list

Returns

Body
GetMembersResponseModel

Response when getting members in a list

When a new list is created

Triggers a workflow when a new list is created

Required Parameters

List ID
string
The unique id for the list

Returns

Body
GetListsResponseModel

Response when getting lists

Definitions

Recipient

Settings for the campaign

List Id
string
The unique list id
segment_opts
Segment_Opts
An object representing all segmentation options

Variate_Settings

Settings for the campaign

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
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
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
Subject Lines
array of string
The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used
Test Size
integer
The percentage of recipients to send the test combinations to, must be a value between 10 and 100
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
Winning 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

Tracking

Settings for the campaign

ClickTale Analytics Tracking
string
The custom slug for ClickTale tracking (max of 50 bytes)
Google Analytics Tracking
string
The custom slug for Google Analytics tracking (max of 50 bytes)
HTML Click Tracking
boolean
Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns
MailChimp Goal Tracking
boolean
Whether to enable Goal tracking
Opens
boolean
Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns
Plain-Text Click Tracking
boolean
Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns
capsule
Capsule
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
eCommerce360 Tracking
boolean
Whether to enable eCommerce360 tracking
highrise
Highrise
Highrise tracking options for a campaign. Must be using MailChimp’s built-in Highrise integration
salesforce
Salesforce
Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration

RSS_Opts

RSS options for a campaign

Constrain RSS Images
string
Whether to add CSS to images in the RSS feed to constrain their width in campaigns
Feed URL
string
The URL for the RSS feed
Frequency
string
The frequency of the RSS Campaign
schedule
Schedule
The schedule for sending the RSS Campaign

Social_Card

Settings for the campaign

Campaign Description
string
A short summary of the campaign to display
Image URL
string
The url for the header image for the card
Title
string
The title for the card. Typically the subject line of the campaign

Segment_Opts

An object representing all segmentation options

Match Type
string
Segment match type: Possible Values: any, all
Saved Segment ID
integer
The id for an existing saved segment

Salesforce

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

Salesforce Campaign
boolean
Create a campaign in a connected Salesforce account
Salesforce Note
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

Highrise Campaign
boolean
Create a campaign in a connected Highrise account
Highrise Note
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

Capsule Note
boolean
Update contact notes for a campaign based on subscriber email addresses

Schedule

The schedule for sending the RSS Campaign

Monthly Sending Day
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
Sending 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
Weekly Sending Day
string
The day of the week to send a weekly RSS Campaign
daily_send
Daily_Send
The days of the week to send a daily RSS Campaign.

Daily_Send

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

Friday
boolean
Sends the daily RSS Campaign on Fridays
Monday
boolean
Sends the daily RSS Campaign on Mondays
Saturday
boolean
Sends the daily RSS Campaign on Saturdays
Sunday
boolean
Sends the daily RSS Campaign on Sundays
Thursday
boolean
Sends the daily RSS Campaign on Thursdays
Tuesday
boolean
Sends the daily RSS Campaign on Tuesdays
Wednesday
boolean
Sends the daily RSS Campaign on Wednesdays

CampaignResponseModel

New Campaign Result Model

Archive URL
string
The link to the campaign’s archive version
Campaign ID
string
A string that uniquely identifies this campaign
Campaign 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
Content Type
string
How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’)
Created Time
string
The date and time the campaign was created
Emails Sent
integer
The total number of emails sent for this campaign
List
array of Recipient
List settings for the campaign
Send Time
string
The time and date a campaign was sent
Status
string
The link to the campaign’s archive version
_links
array of Link
A list of link types and descriptions for the API schema documents
ab_split_opts
AB_Split_Opts
A/B Testing options for a campaign
delivery_status
Delivery_Status
Updates on campaigns in the process of sending
report_summary
Report_Summary
For sent campaigns, a summary of opens, clicks, and unsubscribes
rss_opts
RSS_Opts
RSS options for a campaign
settings
SettingsV2
Settings for the campaign
social_card
Social_Card
Settings for the campaign
tracking
Tracking
Settings for the campaign
variate_settings
Variate_Settings
Settings for the campaign

SettingsV2

Settings for the campaign

Authentication
boolean
Whether MailChimp authenticated the campaign. Defaults to true
Auto Post to Facebook
array of integer
An array of Facebook page ids to auto-post to
Auto-Footer
boolean
Automatically append MailChimp's default footer to the campaign
Auto-Tweet
boolean
Automatically tweet a link to the campaign archive page when the campaign is sent
Campaign Subject Line
string
The subject line for the campaign
Conversation
boolean
Use MailChimp Conversation feature to manage out-of-office replies
Facebook Comments
boolean
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true
Folder ID
string
If the campaign is listed in a folder, the id for that folder
From Name
string
The 'from' name on the campaign (not an email address)
Inline CSS
boolean
Automatically inline the CSS included with the campaign content
Reply To Address
string
The reply-to email address for the campaign
Title
string
The title of the campaign
To Name
string
The campaign's custom 'To' name. Typically the first name merge field

AB_Split_Opts

A/B Testing options for a campaign

From Name Group A
string
For campaigns split on 'From Name', the name for Group A
From Name Group B
string
For campaigns split on 'From Name', the name for Group B
Pick Winner
string
How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'
Reply Email Group A
string
For campaigns split on ‘From Name’, the reply-to address for Group A
Reply Email Group B
string
For campaigns split on ‘From Name’, the reply-to address for Group B
Send Time Group A
string
The send time for Group A
Send Time Group B
string
The send time for Group B
Send Time Winner
string
The send time for the winning version
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
Split Test
string
The type of AB split to run
Subject Line Group A
string
For campaigns split on ‘Subject Line’, the subject line for Group A
Subject Line Group B
string
For campaigns split on ‘Subject Line’, the subject line for Group B
Wait Time
string
How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent
Wait Time
integer
The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent

Report_Summary

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

Automation Opens
integer
The total number of opens for a campaign
Click Rate
float
The number of unique clicks divided by the total number of successful deliveries
Open Rate
float
The number of unique opens divided by the total number of successful deliveries
Total Clicks
integer
The total number of clicks for an campaign
Unique Opens
integer
The number of unique opens
Unique Subscriber Clicks
float
The number of unique clicks

Delivery_Status

Updates on campaigns in the process of sending

Campaign Cancelable
boolean
Whether a campaign send can be canceled
Campaign Delivery Status
string
The current state of a campaign delivery
Delivery Staut Enabled
boolean
Whether Campaign Delivery Status is enabled for this account and campaign
Emails Canceled
integer
The total number of emails canceled for this campaign
Emails Sent
integer
The total number of emails confirmed sent for this campaign so far

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

Href
string
This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action
Method
string
The HTTP method that should be used when accessing the URL defined in ‘href’. (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD)
Rel
string
As with an HTML ‘rel’ attribute, this describes the type of link
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
Target Schema
string
For GETs, this is a URL representing the schema that the response should conform to

Contact

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

Address Line 1
string
The street address for the list contact
Address Line 2
string
The street address for the list contact
City
string
The city for the list contact
Company Name
string
The company name for the list
Country Code
string
A two-character ISO3166 country code. Defaults to US if invalid
Phone Number
string
The phone number for the list contact
Postal Code
string
The postal or zip code for the list contact
State
string
The state for the list contact

Campaign_Defaults

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

Language
string
The default language for this lists’s forms
Sender's Email Address
string
The default from email for campaigns sent to this list
Sender's Name
string
The default from name for campaigns sent to this list
Subject
string
The default subject line for campaigns sent to this list

CreateNewListResponseModel

Create New List Result Model

Beamer Address
string
The list’s Email Beamer address
Creation Date
string
The date and time that this list was created
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
Links
array of Link
A list of link types and descriptions for the API schema documents
List ID
string
A string that uniquely identifies this list
List Name
string
The name of the list
List Rating
integer
An auto-generated activity score for the list (0-5)
Modules
array of string
Any list-specific modules installed for this list
Notify on Subscribe
string
The email address to send subscribe notifications to
Notify on Unsubscribe
string
The email address to send unsubscribe notifications to
Permission Reminder
string
The permission reminder for the list
Subscribe URL Long
string
The full version of this list’s subscribe form (host will vary)
Subscribe URL Short
string
Our EepURL shortened version of this list’s subscribe form
Use Archive Bar
boolean
Whether campaigns for this list use the Archive Bar in archives by default
Visibility
string
Whether this list is public or private
campaign_defaults
Campaign_Defaults
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
contact
Contact
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
stats
Stats
Stats for the list. Many of these are cached for at least five minutes

Stats

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

Average Subscription Rate
float
The average number of subscriptions per month for the list(not returned if we haven’t calculated it yet)
Average Unsubscription Rate
float
The average number of unsubscriptions per month for the list(not returned if we haven’t calculated it yet)
Campaign Count
integer
The number of campaigns in any status that use this list
Campaign Last Sent
date-time
The date and time the last campaign was sent to this list
Cleaned Count
integer
The number of members cleaned from the list
Cleaned Count Since Send
integer
The number of members cleaned from the list since the last campaign was sent
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
string
The date and time of the last time someone subscribed to this list
Date of Last List Unsubscribe
string
The date and time of the last time someone unsubscribed from this list
Member Count
integer
The number of active members in the list
Member Count Since Send
integer
The number of active members in the list since the last campaign was sent
Merge Var Count
integer
The number of merge vars for this list (not EMAIL, which is required)
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)
Target Subscription 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)
Unsubscribe Count
integer
The number of members who have unsubscribed from the list
Unsubscribe Count Since Send
integer
The number of members who have unsubscribed since the last campaign was sent

GetListsResponseModel

Response when getting lists

Lists
array of CreateNewListResponseModel
An array of objects, each representing a list

FirstAndLastName

Merged fields containing User First name and last name

First Name
string
First name of the subscriber
Last Name
string
Last name of the subscriber

Location

Subscriber location information

Latitude
float
The location latitude
Longitude
float
The location longitude

MemberResponseModel

Member Result Model

Email Address
string
Email address for a subscriber
Email Client
string
The list member’s email client
Email ID
string
The MD5 hash of the lowercase version of the list member’s email address
Email Type
string
Type of email this member asked to get (‘html’ or ‘text’).
Language
string
If set/detected, the subscriber’s language
Last Changed Date
string
Date and time the member’s info was last changed
Links
array of Link
A list of link types and descriptions for the API schema documents
List ID
string
The list id
Member Rating
integer
Star rating for this member, between 1 and 5
Opt-in IP
string
The IP address the subscriber used to confirm their opt-in status
Opt-in Timestamp
string
Date and time the subscribe confirmed their opt-in status
Signup IP
string
IP address the subscriber signed up from
Signup Timestamp
string
Date and time the subscriber signed up for the list
Status
string
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending
Unique Email ID
string
An identifier for the address across all of MailChimp
VIP
boolean
VIP status for subscriber
last_note
Last_Note
THe most recent Note added about this member
location
Location
Subscriber location information
merge_fields
FirstAndLastName
Merged fields containing User First name and last name
stats
Stats
Stats for the list. Many of these are cached for at least five minutes

Last_Note

THe most recent Note added about this member

Author
string
The author of the note
Created Time
string
The date the note was created
Note
string
The content of the note
Note ID
integer
The note id

GetMembersResponseModel

Response when getting members in a list

Members
array of AddUserResponseModel
An array of objects, each representing a specific list member

AddUserResponseModel

New Campaign Result Model

Email Address
string
Email address for a subscriber
Email Client
string
The list member’s email client
Email ID
string
The MD5 hash of the lowercase version of the list member’s email address
Email Type
string
Type of email this member asked to get (‘html’ or ‘text’).
Language
string
If set/detected, the subscriber’s language
Last Changed Date
string
Date and time the member’s info was last changed
Links
array of Link
A list of link types and descriptions for the API schema documents
List ID
string
The list id
Member Rating
integer
Star rating for this member, between 1 and 5
Opt-in IP
string
The IP address the subscriber used to confirm their opt-in status
Opt-in Timestamp
string
Date and time the subscribe confirmed their opt-in status
Signup IP
string
IP address the subscriber signed up from
Signup Timestamp
string
Date and time the subscriber signed up for the list
Status
string
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending
Unique Email ID
string
An identifier for the address across all of MailChimp
VIP
boolean
VIP status for subscriber
last_note
Last_Note
THe most recent Note added about this member
location
Location
Subscriber location information
merge_fields
FirstAndLastName
Merged fields containing User First name and last name
stats
Stats
Stats for the list. Many of these are cached for at least five minutes