- Version:
- 1.0
| Campaign Related Methods |
| static |
campaignContent(string uid, string cid)
Get the content (both html and text) for a campaign, exactly as it would appear in the campaign archive
|
| static |
campaignCreate(string uid, string list_id, string subject, string from_email, string from_name, array content, integer template_id, array tracking, boolean authenticate, string analytics, string title)
Create a new draft campaign to send
|
| static |
campaignFolders(string uid)
List all the folders for a user account
|
| static |
campaignSchedule(string uid, string cid, string schedule_time)
Schedule a campaign to be sent in the future
|
| static |
campaignSendNow(string uid, string cid)
Send a given campaign immediately
|
| static |
campaignSendTest(string uid, string cid, array test_emails, string send_type)
Send a test of this campaign to the provided email address
|
| static |
campaignTemplates(string uid)
Retrieve all templates defined for your user account
|
| static |
campaignUnschedule(string uid, string cid)
Unschedule a campaign that is scheduled to be sent in the future
|
| static |
campaigns(string uid, string filter_id, integer filter_folder, string filter_fromname, string filter_fromemail, string filter_title, string filter_subject, string filter_sendtimestart, string filter_sendtimeend, boolean filter_exact, integer start, integer limit)
Get the list of campaigns and associated information for a list
|
| Campaign Stats Methods |
| static |
campaignAbuseReports(string uid, string cid, int start, int limit)
Get all email addresses that complained about a given campaign
|
| static |
campaignBounces(string uid, string cid)
Get all bounced email addresses for a given campaign
DEPRECATED: campaignBounces() has been deprecated and will be removed completely in a future release. |
| static |
campaignClickStats(string uid, string cid)
Get an array of the urls being tracked, and their click counts for a given campaign
|
| static |
campaignHardBounces(string uid, string cid, int start, int limit)
Get all email addresses with Hard Bounces for a given campaign
|
| static |
campaignSoftBounces(string uid, string cid, int start, int limit)
Get all email addresses with Soft Bounces for a given campaign
|
| static |
campaignStats(string uid, string cid)
Given a list and a campaign, get all the relevant campaign statistics (opens, bounces, clicks, etc.)
|
| static |
campaignUnsubscribes(string uid, string cid, int start, int limit)
Get all unsubscribed email addresses for a given campaign
|
| Campaign AIM Methods |
| static |
campaignClickDetailAIM(string uid, string cid, string url, int start, int limit)
Return the list of email addresses that clicked on a given url, and how many times they clicked
|
| static |
campaignEmailStatsAIM(string uid, string cid, string email_address)
Given a campaign and email address, return the entire click and open history with timestamps, ordered by time
|
| static |
campaignNotOpenedAIM(string uid, string cid, int start, int limit)
Retrieve the list of email addresses that did not open a given campaign
|
| static |
campaignOpenedAIM(string uid, string cid, int start, int limit)
Retrieve the list of email addresses that opened a given campaign with how many times they opened
|
| List Related Methods |
| static |
listBatchSubscribe(string uid, string id, array batch, boolean double_optin, boolean update_existing, boolean replace_interests)
Subscribe a batch of email addresses to a list at once
|
| static |
listBatchUnsubscribe(string uid, string id, array emails, boolean delete_member, boolean send_goodbye, boolean send_notify)
Unsubscribe a batch of email addresses to a list
|
| static |
listInterestGroups(string uid, string id)
Get the list of interest groups for a given list, including the label and form information
|
| static |
listMemberInfo(string uid, string id, string email_address)
Get all the information for a particular member of a list
|
| static |
listMembers(string uid, string id, string status, int start, int limit)
Get all of the list members of a list that are of a particular status
|
| static |
listMergeVars(string uid, string id)
Get the list of merge tags for a given list, including their name, tag, and required setting
|
| static |
listSubscribe(string uid, string id, string email_address, array merge_vars, string email_type, boolean double_optin)
Subscribe the provided email to a list
|
| static |
listUnsubscribe(string uid, string id, string email_address, boolean delete_member, boolean send_goodbye, boolean send_notify)
Unsubscribe the given email address from the list
|
| static |
listUpdateMember(string uid, string id, string email_address, array merge_vars, string email_type, boolean replace_interests)
Edit the email address, merge fields, and interest groups for a list member
|
| static |
lists(string uid)
Retrieve all of the lists defined for your user account
|
| Security Related Methods |
| static |
closeOneOhSecurityHole(string username, string password)
Disable a pretty bad security hole that exists in our 1.0 version of the API. |
| static |
login(string username, string password)
Log into the MailChimp API - see closeOneOhSecurityHole() !!!!
|
|
Submit URL & Parameters
The submit URL for the formats supported are relatively the same. Specifically, use these:For XML-RPC, simply tell your client to connect to:
http://api.mailchimp.com/1.0/
For Serialized JSON, use:
http://api.mailchimp.com/1.0/?output=json&method=SOME-METHOD&[other parameters]
For Serialized XML, use:
http://api.mailchimp.com/1.0/?output=xml&method=SOME-METHOD&[other parameters]
For Serialized PHP, use:
http://api.mailchimp.com/1.0/?output=php&method=SOME-METHOD&[other parameters]
Note that for the Serialized versions, method is the method from our API you are calling and [other parameters] are the parameters the documentation calls for.
Questions? Problems?
Have you run into difficulties or a method just doesn't seem to work right? Our API Support team is just an email away and will be happy to assist you.