MailChimp is a SaaS service that allows businesses to manage and automate email marketing activities, including sending marketing emails, automated messages and targeted campaigns.
Status: Production |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
New Campaign |
|
List campaigns |
|
New Campaign (V2) |
|
Send Campaign |
|
Get all the lists |
|
New List |
|
Subscribe or unsubscribe list members |
|
Show list members |
|
addmember (string list_id, NewMemberInListRequest newMemberInList) |
Add member to list |
Remove Member from list (Deprecated) |
|
Update member information. (Deprecated) |
|
Remove Member from list |
|
Update member information |
Name |
Summary |
When a Member has been added to a list |
|
When a new list is created |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: New Campaign
Description: Create a new campaign based on a Campaign Type, Recipients list and Campaign Settings (subject line, title, from_name and reply_to)
Syntax:
MailChimp.newcampaign (NewCampaignRequest newCampaignRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
newCampaignRequest |
|
Body parameters to create a new campaign |
True |
Returns:
Description: New Campaign Result Model
Summary: List campaigns
Description: This operation retrieves a list of campaigns in an account
Syntax:
MailChimp.GetCampaigns ()
Returns:
Type:GetCampaignsResponse
Description: Response when getting campaigns
Summary: New Campaign (V2)
Description: Create a new campaign based on a Campaign Type, Recipients list and Campaign Settings (subject line, title, from_name and reply_to) (V2).
Syntax:
MailChimp.newcampaignV2 (NewCampaignRequestV2 newCampaignRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
newCampaignRequest |
|
Body parameters to create a new campaign (V2) |
True |
Returns:
Description: New Campaign Result Model
Summary: Send Campaign
Description: Send an existing campaign
Syntax:
MailChimp.sendcampaign (string campaign_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
campaign_id |
string (Campaign) |
The unique id for the list |
True |
Returns:
Summary: Get all the lists
Description: Find all the lists for the current user
Syntax:
MailChimp.GetLists ()
Returns:
Description: Response when getting lists
Summary: New List
Description: Create a new list in your MailChimp account
Syntax:
MailChimp.newlist (NewListRequest newListRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
newListRequest |
|
Body parameters to create a new campaign |
True |
Returns:
Type:CreateNewListResponseModel
Description: Create New List Result Model
Summary: Subscribe or unsubscribe list members
Description: Batch subscribe or unsubscribe list members.
Syntax:
MailChimp.AddMembers (string list_id, [advanced][Optional]boolean skip_merge_validation, [advanced][Optional]boolean skip_duplicate_check, NewMembersInListRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
list_id |
string (List Id) |
The unique id for the list |
True |
|
skip_merge_validation |
boolean (Skip Merge Validation) |
Allows member data to be accepted without merge field values |
False |
|
skip_duplicate_check |
boolean (Skip Duplicate Check) |
Ignores duplicates sent in the request |
False |
|
body |
|
Add new members to the list |
True |
Returns:
Type:GetAddMembersBatchResponseModel
Description: Response when subscribing or unsubscribing list members in a batch
Summary: Show list members
Description: Show all the members of a list
Syntax:
MailChimp.GetListMembers (string list_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
list_id |
string (List Id) |
The unique id for the list |
True |
Returns:
Type:GetAllMembersResponseModel
Description: Response when querying for all members in a list
Summary: Add member to list
Description: Add or update a list member
Syntax:
MailChimp.addmember (string list_id, NewMemberInListRequest newMemberInList)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
list_id |
string (List Id) |
The unique id for the list |
True |
|
newMemberInList |
|
Add a new member to the list |
True |
Returns:
Type:MemberResponseModel
Description: Member Result Model
Summary: Remove Member from list (Deprecated)
Description: Delete a member from a list. (Deprecated)
Syntax:
MailChimp.removemember (string list_id, string member_email)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
list_id |
string (List Id) |
The unique id for the list |
True |
|
member_email |
string (Member email) |
The email address of the member to delete |
True |
Returns:
Summary: Update member information. (Deprecated)
Description: Update information for a specific list member (Deprecated)
Syntax:
MailChimp.updatemember (string list_id, string member_email, UpdateMemberInListRequest updateMemberInListRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
list_id |
string (List Id) |
The unique id for the list |
True |
|
member_email |
string (Member email) |
The unique email address of the member to update |
True |
|
updateMemberInListRequest |
|
Body parameters to update a member in a list |
True |
Returns:
Type:MemberResponseModel
Description: Member Result Model
Summary: Remove Member from list
Description: Delete a member from a list.
Syntax:
MailChimp.removemember_v2 (string list_id, string member_email)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
list_id |
string (List Id) |
The unique id for the list |
True |
|
member_email |
string (Member email) |
The email address of the member to delete |
True |
Returns:
Summary: Update member information
Description: Update information for a specific list member.
Syntax:
MailChimp.updatemember_v2 (string list_id, string member_email, UpdateMemberInListRequest updateMemberInListRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
list_id |
string (List Id) |
The unique id for the list |
True |
|
member_email |
string (Member email) |
The unique email address of the member to update |
True |
|
updateMemberInListRequest |
|
Body parameters to update a member in a list |
True |
Returns:
Type:MemberResponseModel
Description: Member Result Model
Summary: When a Member has been added to a list
Description: Triggers a workflow when a new member has been added to a list
Syntax:
MailChimp.OnMemberSubscribed (string list_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
list_id |
string (List ID) |
The unique id for the list |
True |
Returns:
Description: Response when getting members in a list
Summary: When a new list is created
Description: Triggers a workflow when a new list is created
Syntax:
MailChimp.OnCreateList ()
Returns:
Description: Response when getting lists
Summary:
Description: A/B Testing options for a campaign
Properties:
Name |
Type |
Summary |
split_test |
string Split Test |
The type of AB split to run |
pick_winner |
string Pick Winner |
How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual' |
wait_units |
string Wait Time |
How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent |
wait_time |
integer(int32) Wait Time |
The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent |
split_size |
integer(int32) Split Size |
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_a |
string From Name Group A |
For campaigns split on 'From Name', the name for Group A |
from_name_b |
string From Name Group B |
For campaigns split on 'From Name', the name for Group B |
reply_email_a |
string Reply Email Group A |
For campaigns split on ‘From Name’, the reply-to address for Group A |
reply_email_b |
string Reply Email Group B |
For campaigns split on ‘From Name’, the reply-to address for Group B |
subject_a |
string Subject Line Group A |
For campaigns split on ‘Subject Line’, the subject line for Group A |
subject_b |
string Subject Line Group B |
For campaigns split on ‘Subject Line’, the subject line for Group B |
send_time_a |
string Send Time Group A |
The send time for Group A |
send_time_b |
string Send Time Group B |
The send time for Group B |
send_time_winner |
string Send Time Winner |
The send time for the winning version |
Summary:
Description: New Campaign Result Model
Properties:
Name |
Type |
Summary |
id |
string Email ID |
The MD5 hash of the lowercase version of the list member’s email address |
email_address |
string Email Address |
Email address for a subscriber |
unique_email_id |
string Unique Email ID |
An identifier for the address across all of MailChimp |
email_type |
string Email Type |
Type of email this member asked to get (‘html’ or ‘text’). |
status |
string Status |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending |
merge_fields |
|
Merged fields containing User First name and last name |
stats |
|
Stats for the list. Many of these are cached for at least five minutes |
ip_signup |
string Signup IP |
IP address the subscriber signed up from |
timestamp_signup |
string Signup Timestamp |
Date and time the subscriber signed up for the list |
ip_opt |
string Opt-in IP |
The IP address the subscriber used to confirm their opt-in status |
timestamp_opt |
string Opt-in Timestamp |
Date and time the subscribe confirmed their opt-in status |
member_rating |
integer(int32) Member Rating |
Star rating for this member, between 1 and 5 |
last_changed |
string Last Changed Date |
Date and time the member’s info was last changed |
language |
string Language |
If set/detected, the subscriber’s language |
vip |
boolean VIP |
VIP status for subscriber |
email_client |
string Email Client |
The list member’s email client |
location |
|
Subscriber location information |
last_note |
|
THe most recent Note added about this member |
list_id |
string List ID |
The list id |
_links |
array of (Link) Links |
A list of link types and descriptions for the API schema documents |
Summary:
Description: New Campaign Result Model
Properties:
Name |
Type |
Summary |
id |
string Campaign ID |
A string that uniquely identifies this campaign |
type |
string Campaign Type |
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 Values: [, regular, plaintext, absplit, rss, variate] |
create_time |
string Created Time |
The date and time the campaign was created |
archive_url |
string Archive URL |
The link to the campaign’s archive version |
status |
string Status |
The link to the campaign’s archive version |
emails_sent |
integer(int32) Emails Sent |
The total number of emails sent for this campaign |
send_time |
string Send Time |
The time and date a campaign was sent |
content_type |
string Content Type |
How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’) |
recipient |
array of (Recipient) List |
List settings for the campaign |
settings |
|
Settings for the campaign |
variate_settings |
|
Settings for the campaign |
tracking |
|
Settings for the campaign |
rss_opts |
|
RSS options for a campaign |
ab_split_opts |
|
A/B Testing options for a campaign |
social_card |
|
Settings for the campaign |
report_summary |
|
For sent campaigns, a summary of opens, clicks, and unsubscribes |
delivery_status |
|
Updates on campaigns in the process of sending |
_links |
array of (Link)
|
A list of link types and descriptions for the API schema documents |
Summary:
Description: Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
Properties:
Name |
Type |
Summary |
from_name |
string Sender's Name |
The default from name for campaigns sent to this list |
from_email |
string Sender's Email Address |
The default from email for campaigns sent to this list |
subject |
string Subject |
The default subject line for campaigns sent to this list |
language |
string Language |
The default language for this lists’s forms Values: [, en, ar, af, be, bg, ca, zh, hr, cs, da, nl, et, fa, fi, fr, fr_CA, de, el, he, hi, hu, is, id, ga, it, ja, km, ko, lv, lt, mt, ms, mk, no, pl, pt, pt_PT, ro, ru, sr, sk, sl, es, es_ES, sw, sv, ta, th, tr, uk, vi] |
Summary:
Description: Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
Properties:
Name |
Type |
Summary |
notes |
boolean Capsule Note |
Update contact notes for a campaign based on subscriber email addresses |
Summary:
Description: Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
Properties:
Name |
Type |
Summary |
company |
string Company Name |
The company name for the list |
address1 |
string Address Line 1 |
The street address for the list contact |
address2 |
string Address Line 2 |
The street address for the list contact |
city |
string City |
The city for the list contact |
state |
string State |
The state for the list contact |
zip |
string Postal Code |
The postal or zip code for the list contact |
country |
string Country Code |
A two-character ISO3166 country code. Defaults to US if invalid |
phone |
string Phone Number |
The phone number for the list contact |
Summary:
Description: Create New List Result Model
Properties:
Name |
Type |
Summary |
id |
string List ID |
A string that uniquely identifies this list |
name |
string List Name |
The name of the list |
contact |
|
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration |
permission_reminder |
string Permission Reminder |
The permission reminder for the list |
use_archive_bar |
boolean Use Archive Bar |
Whether campaigns for this list use the Archive Bar in archives by default |
campaign_defaults |
|
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration |
notify_on_subscribe |
string Notify on Subscribe |
The email address to send subscribe notifications to |
notify_on_unsubscribe |
string Notify on Unsubscribe |
The email address to send unsubscribe notifications to |
date_created |
string Creation Date |
The date and time that this list was created |
list_rating |
integer(int32) List Rating |
An auto-generated activity score for the list (0-5) |
email_type_option |
boolean Email Type Option |
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 |
string Subscribe URL Short |
Our EepURL shortened version of this list’s subscribe form |
subscribe_url_long |
string Subscribe URL Long |
The full version of this list’s subscribe form (host will vary) |
beamer_address |
string Beamer Address |
The list’s Email Beamer address |
visibility |
string Visibility |
Whether this list is public or private |
modules |
array of (string) Modules |
Any list-specific modules installed for this list |
stats |
|
Stats for the list. Many of these are cached for at least five minutes |
_links |
array of (Link) Links |
A list of link types and descriptions for the API schema documents |
Summary:
Description: The days of the week to send a daily RSS Campaign.
Properties:
Name |
Type |
Summary |
sunday |
boolean Sunday |
Sends the daily RSS Campaign on Sundays |
monday |
boolean Monday |
Sends the daily RSS Campaign on Mondays |
tuesday |
boolean Tuesday |
Sends the daily RSS Campaign on Tuesdays |
wednesday |
boolean Wednesday |
Sends the daily RSS Campaign on Wednesdays |
thursday |
boolean Thursday |
Sends the daily RSS Campaign on Thursdays |
friday |
boolean Friday |
Sends the daily RSS Campaign on Fridays |
saturday |
boolean Saturday |
Sends the daily RSS Campaign on Saturdays |
Summary:
Description: Updates on campaigns in the process of sending
Properties:
Name |
Type |
Summary |
enabled |
boolean Delivery Staut Enabled |
Whether Campaign Delivery Status is enabled for this account and campaign |
can_cancel |
boolean Campaign Cancelable |
Whether a campaign send can be canceled |
status |
string Campaign Delivery Status |
The current state of a campaign delivery |
emails_sent |
integer(int32) Emails Sent |
The total number of emails confirmed sent for this campaign so far |
emails_canceled |
integer(int32) Emails Canceled |
The total number of emails canceled for this campaign |
Summary:
Description: Merged fields containing User First name and last name
Properties:
Name |
Type |
Summary |
FNAME |
string First Name |
First name of the subscriber |
LNAME |
string Last Name |
Last name of the subscriber |
Summary:
Description: Response when subscribing or unsubscribing list members in a batch
Properties:
Name |
Type |
Summary |
total_created |
integer Total Created |
Total number of members that were added to the list |
total_updated |
integer(int32) Total Updated |
The total number of an existing list members whose subscription status was updated |
error_count |
integer(int32) Error Count |
The number email addresses that could not be added to the list or updated |
Summary:
Description: Response when querying for all members in a list
Properties:
Name |
Type |
Summary |
members |
array of (MemberResponseModel) Members |
An array of objects, each representing a specific list member |
list_id |
string List Id |
The list id |
total_items |
integer(int32) Total Items |
The total number of items matching the query regardless of pagination |
Summary:
Description: Response when getting campaigns
Properties:
Name |
Type |
Summary |
campaigns |
array of (CampaignResponseModel) Campaigns |
An array of objects, each representing a campaign |
Summary:
Description: Response when getting lists
Properties:
Name |
Type |
Summary |
lists |
array of (CreateNewListResponseModel) Lists |
An array of objects, each representing a list |
total_items |
integer(int32) Item Count |
The total number of items matching the query regardless of pagination |
Summary:
Description: Response when getting members in a list
Properties:
Name |
Type |
Summary |
members |
array of (AddUserResponseModel) Members |
An array of objects, each representing a specific list member |
list_id |
string List ID |
The list id |
total_items |
integer(int32) Item Count |
The total number of items matching the query regardless of pagination |
Summary:
Description: Highrise tracking options for a campaign. Must be using MailChimp’s built-in Highrise integration
Properties:
Name |
Type |
Summary |
campaign |
boolean Highrise Campaign |
Create a campaign in a connected Highrise account |
notes |
boolean Highrise Note |
Update contact notes for a campaign based on subscriber email addresses |
Summary:
Description: THe most recent Note added about this member
Properties:
Name |
Type |
Summary |
note_id |
integer(int32) Note ID |
The note id |
created_at |
string Created Time |
The date the note was created |
created_by |
string Author |
The author of the note |
note |
string Note |
The content of the note |
Summary:
Description: Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration
Properties:
Name |
Type |
Summary |
rel |
string Rel |
As with an HTML ‘rel’ attribute, this describes the type of link |
href |
string Href |
This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action |
method |
string Method |
The HTTP method that should be used when accessing the URL defined in ‘href’. (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD) |
targetSchema |
string Target Schema |
For GETs, this is a URL representing the schema that the response should conform to |
schema |
string Schema |
For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to |
Summary:
Description: Subscriber location information
Properties:
Name |
Type |
Summary |
latitude |
number(float) Latitude |
The location latitude |
longitude |
number(float) Longitude |
The location longitude |
Summary:
Description: Member Result Model
Properties:
Name |
Type |
Summary |
id |
string Email ID |
The MD5 hash of the lowercase version of the list member’s email address |
email_address |
string Email Address |
Email address for a subscriber |
unique_email_id |
string Unique Email ID |
An identifier for the address across all of MailChimp |
email_type |
string Email Type |
Type of email this member asked to get (‘html’ or ‘text’). |
status |
string Status |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending |
merge_fields |
|
Merged fields containing User First name and last name |
stats |
|
Stats for the list. Many of these are cached for at least five minutes |
ip_signup |
string Signup IP |
IP address the subscriber signed up from |
timestamp_signup |
string Signup Timestamp |
Date and time the subscriber signed up for the list |
ip_opt |
string Opt-in IP |
The IP address the subscriber used to confirm their opt-in status |
timestamp_opt |
string Opt-in Timestamp |
Date and time the subscribe confirmed their opt-in status |
member_rating |
integer(int32) Member Rating |
Star rating for this member, between 1 and 5 |
last_changed |
string Last Changed Date |
Date and time the member’s info was last changed |
language |
string Language |
If set/detected, the subscriber’s language |
vip |
boolean VIP |
VIP status for subscriber |
email_client |
string Email Client |
The list member’s email client |
location |
|
Subscriber location information |
last_note |
|
THe most recent Note added about this member |
list_id |
string List ID |
The list id |
_links |
array of (Link) Links |
A list of link types and descriptions for the API schema documents |
Summary:
Description: Body parameters to create a new campaign
Properties:
Name |
Type |
Summary |
type |
string Campaign Type |
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 Values: [, regular, plaintext, absplit, rss, variate] |
recipients |
|
Settings for the campaign |
settings |
|
Settings for the campaign |
variate_settings |
|
Settings for the campaign |
tracking |
|
Settings for the campaign |
rss_opts |
|
RSS options for a campaign |
social_card |
|
Settings for the campaign |
Summary:
Description: Body parameters to create a new campaign (V2)
Properties:
Name |
Type |
Summary |
type |
string Campaign Type |
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 Values: [, regular, plaintext, absplit, rss, variate] |
recipients |
|
Settings for the campaign |
settings |
|
Settings for the campaign |
variate_settings |
|
Settings for the campaign |
tracking |
|
Settings for the campaign |
rss_opts |
|
RSS options for a campaign |
social_card |
|
Settings for the campaign |
Summary:
Description: Body parameters to create a new campaign
Properties:
Name |
Type |
Summary |
name |
string List Name |
The name of the list |
contact |
|
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration |
permission_reminder |
string Permission Reminder |
Text to remind people how they signed up to this list |
use_archive_bar |
boolean Use Archive Bar |
Whether campaigns for this list use the Archive Bar in archives by default |
campaign_defaults |
|
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration |
notify_on_subscribe |
string Notify on Subscribe |
The email address to send subscribe notifications to |
notify_on_unsubscribe |
string Notify on Unsubscribe |
The email address to send unsubscribe notifications to |
email_type_option |
boolean Allow users to choose between HTML and Plain text (true/false)? |
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 |
string Visibility |
Whether this list is public or private Values: [, pub, prv] |
Summary:
Description: Add a new member to the list
Properties:
Name |
Type |
Summary |
email_type |
string Email Type |
Type of email this member asked to get (‘html’ or ‘text’) Values: [, html, text] |
status |
string Status |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending Values: [, subscribed, unsubscribed, cleaned, pending] |
merge_fields |
|
Merged fields containing User First name and last name |
language |
string Language |
If set/detected, the subscriber’s language |
vip |
boolean VIP |
VIP status for subscriber |
location |
|
Subscriber location information |
email_address |
string Email Address |
Email address for a subscriber |
Summary:
Description: Add new members to the list
Properties:
Name |
Type |
Summary |
members |
array of (NewMemberInListRequest)
|
An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call. |
update_existing |
boolean
|
Whether this batch operation will change existing members' subscription status. |
Summary:
Description: Settings for the campaign
Properties:
Name |
Type |
Summary |
list_id |
string List Id |
The unique list id |
segment_opts |
|
An object representing all segmentation options |
Summary:
Description: For sent campaigns, a summary of opens, clicks, and unsubscribes
Properties:
Name |
Type |
Summary |
opens |
integer(int32) Automation Opens |
The total number of opens for a campaign |
unique_opens |
integer(int32) Unique Opens |
The number of unique opens |
open_rate |
number(float) Open Rate |
The number of unique opens divided by the total number of successful deliveries |
clicks |
integer(int32) Total Clicks |
The total number of clicks for an campaign |
subscriber_clicks |
number(float) Unique Subscriber Clicks |
The number of unique clicks |
click_rate |
number(float) Click Rate |
The number of unique clicks divided by the total number of successful deliveries |
Summary:
Description: RSS options for a campaign
Properties:
Name |
Type |
Summary |
feed_url |
string Feed URL |
The URL for the RSS feed |
frequency |
string Frequency |
The frequency of the RSS Campaign Values: [, daily, weekly, monthly] |
constrain_rss_img |
string Constrain RSS Images |
Whether to add CSS to images in the RSS feed to constrain their width in campaigns |
schedule |
|
The schedule for sending the RSS Campaign |
Summary:
Description: Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration
Properties:
Name |
Type |
Summary |
campaign |
boolean Salesforce Campaign |
Create a campaign in a connected Salesforce account |
notes |
boolean Salesforce Note |
Update contact notes for a campaign based on subscriber email addresses |
Summary:
Description: The schedule for sending the RSS Campaign
Properties:
Name |
Type |
Summary |
hour |
integer(int32) Sending Hour |
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 |
|
The days of the week to send a daily RSS Campaign. |
weekly_send_day |
string Weekly Sending Day |
The day of the week to send a weekly RSS Campaign Values: [, sunday, monday, tuesday, wednesday, thursday, friday, saturday] |
monthly_send_date |
number(float) Monthly Sending Day |
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 |
Summary:
Description: An object representing all segmentation options
Properties:
Name |
Type |
Summary |
saved_segment_id |
integer(int32) Saved Segment ID |
The id for an existing saved segment |
match |
string Match Type |
Segment match type: Possible Values: any, all |
Summary:
Description: Settings for the campaign
Properties:
Name |
Type |
Summary |
subject_line |
string Campaign Subject Line |
The subject line for the campaign |
title |
string Title |
The title of the campaign |
from_name |
string From Name |
The 'from' name on the campaign (not an email address) |
reply_to |
string Reply To Address |
The reply-to email address for the campaign |
use_conversation |
boolean Conversation |
Use MailChimp Conversation feature to manage out-of-office replies |
to_name |
string To Name |
The campaign's custom 'To' name. Typically the first name merge field |
folder_id |
integer(int32) Folder ID |
If the campaign is listed in a folder, the id for that folder |
authenticate |
boolean Authentication |
Whether MailChimp authenticated the campaign. Defaults to true |
auto_footer |
boolean Auto-Footer |
Automatically append MailChimp's default footer to the campaign |
inline_css |
boolean Inline CSS |
Automatically inline the CSS included with the campaign content |
auto_tweet |
boolean Auto-Tweet |
Automatically tweet a link to the campaign archive page when the campaign is sent |
auto_fb_post |
array of (integer(int32)) Auto Post to Facebook |
An array of Facebook page ids to auto-post to |
fb_comments |
boolean Facebook Comments |
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true |
Summary:
Description: Settings for the campaign
Properties:
Name |
Type |
Summary |
subject_line |
string Campaign Subject Line |
The subject line for the campaign |
title |
string Title |
The title of the campaign |
from_name |
string From Name |
The 'from' name on the campaign (not an email address) |
reply_to |
string Reply To Address |
The reply-to email address for the campaign |
use_conversation |
boolean Conversation |
Use MailChimp Conversation feature to manage out-of-office replies |
to_name |
string To Name |
The campaign's custom 'To' name. Typically the first name merge field |
folder_id |
string Folder ID |
If the campaign is listed in a folder, the id for that folder |
authenticate |
boolean Authentication |
Whether MailChimp authenticated the campaign. Defaults to true |
auto_footer |
boolean Auto-Footer |
Automatically append MailChimp's default footer to the campaign |
inline_css |
boolean Inline CSS |
Automatically inline the CSS included with the campaign content |
auto_tweet |
boolean Auto-Tweet |
Automatically tweet a link to the campaign archive page when the campaign is sent |
auto_fb_post |
array of (integer(int32)) Auto Post to Facebook |
An array of Facebook page ids to auto-post to |
fb_comments |
boolean Facebook Comments |
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true |
Summary:
Description: Settings for the campaign
Properties:
Name |
Type |
Summary |
image_url |
string Image URL |
The url for the header image for the card |
description |
string Campaign Description |
A short summary of the campaign to display |
title |
string Title |
The title for the card. Typically the subject line of the campaign |
Summary:
Description: Stats for the list. Many of these are cached for at least five minutes
Properties:
Name |
Type |
Summary |
member_count |
integer(int32) Member Count |
The number of active members in the list |
unsubscribe_count |
integer(int32) Unsubscribe Count |
The number of members who have unsubscribed from the list |
cleaned_count |
integer(int32) Cleaned Count |
The number of members cleaned from the list |
member_count_since_send |
integer(int32) Member Count Since Send |
The number of active members in the list since the last campaign was sent |
unsubscribe_count_since_send |
integer(int32) Unsubscribe Count Since Send |
The number of members who have unsubscribed since the last campaign was sent |
cleaned_count_since_send |
integer(int32) Cleaned Count Since Send |
The number of members cleaned from the list since the last campaign was sent |
campaign_count |
integer(int32) Campaign Count |
The number of campaigns in any status that use this list |
campaign_last_sent |
string(date-time) Campaign Last Sent |
The date and time the last campaign was sent to this list |
merge_field_count |
integer(int32) Merge Var Count |
The number of merge vars for this list (not EMAIL, which is required) |
avg_sub_rate |
number(float) Average Subscription Rate |
The average number of subscriptions per month for the list(not returned if we haven’t calculated it yet) |
avg_unsub_rate |
number(float) Average Unsubscription Rate |
The average number of unsubscriptions per month for the list(not returned if we haven’t calculated it yet) |
target_sub_rate |
number(float) Target Subscription Rate |
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 |
number(float) Open Rate |
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 |
number(float) Click Rate |
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) |
last_sub_date |
string Date of Last List Subscribe |
The date and time of the last time someone subscribed to this list |
last_unsub_date |
string Date of Last List Unsubscribe |
The date and time of the last time someone unsubscribed from this list |
Summary:
Description: Settings for the campaign
Properties:
Name |
Type |
Summary |
opens |
boolean Opens |
Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns |
html_clicks |
boolean HTML Click Tracking |
Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns |
text_clicks |
boolean Plain-Text Click Tracking |
Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns |
goal_tracking |
boolean MailChimp Goal Tracking |
Whether to enable Goal tracking |
ecomm360 |
boolean eCommerce360 Tracking |
Whether to enable eCommerce360 tracking |
google_analytics |
string Google Analytics Tracking |
The custom slug for Google Analytics tracking (max of 50 bytes) |
clicktale |
string ClickTale Analytics Tracking |
The custom slug for ClickTale tracking (max of 50 bytes) |
salesforce |
|
Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration |
highrise |
|
Highrise tracking options for a campaign. Must be using MailChimp’s built-in Highrise integration |
capsule |
|
Capsule tracking options for a campaign. Must be using MailChimp’s built-in Capsule integration |
Summary:
Description: Body parameters to update a member in a list
Properties:
Name |
Type |
Summary |
email_type |
string Email Type |
Type of email this member asked to get (‘html’ or ‘text’) Values: [, html, text] |
status |
string Status |
Subscriber’s current status. Possible Values: subscribed, unsubscribed, cleaned, pending Values: [, subscribed, unsubscribed, cleaned, pending] |
merge_fields |
|
Merged fields containing User First name and last name |
language |
string Language |
If set/detected, the subscriber’s language |
vip |
boolean VIP |
VIP status for subscriber |
location |
|
Subscriber location information |
Summary:
Description: Settings for the campaign
Properties:
Name |
Type |
Summary |
winner_criteria |
string Winning Criteria |
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(int32) Wait Time |
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(int32) Test Size |
The percentage of recipients to send the test combinations to, must be a value between 10 and 100 |
subject_lines |
array of (string) Subject Lines |
The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used |
send_times |
array of (string) Send Times |
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 |
array of (string) From Names |
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) Reply To Addresses |
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 |