MCAPI
===============


* Class name: MCAPI
* Namespace: 


Properties
----------


### $version

    public mixed $version = "1.3"


* Visibility: **public**


### $errorMessage

    public mixed $errorMessage


* Visibility: **public**


### $errorCode

    public mixed $errorCode


* Visibility: **public**


### $apiUrl

    public mixed $apiUrl

Cache the information on the API location on the server


* Visibility: **public**


### $timeout

    public mixed $timeout = 300

Default to a 300 second timeout on server calls


* Visibility: **public**


### $chunkSize

    public mixed $chunkSize = 8192

Default to a 8K chunk size


* Visibility: **public**


### $api_key

    public mixed $api_key

Cache the user api_key so we only have to log in once per client instantiation


* Visibility: **public**


### $secure

    public mixed $secure = false

Cache the user api_key so we only have to log in once per client instantiation


* Visibility: **public**


Methods
-------


### MCAPI

    mixed MCAPI::MCAPI(string $apikey, string $secure)

Connect to the MailChimp API for a given list.


* Visibility: **public**


#### Arguments
* $apikey **string** - &lt;p&gt;Your MailChimp apikey&lt;/p&gt;
* $secure **string** - &lt;p&gt;Whether or not this should use a secure connection&lt;/p&gt;


### setTimeout

    mixed MCAPI::setTimeout($seconds)


* Visibility: **public**


#### Arguments
* $seconds **mixed**


### getTimeout

    mixed MCAPI::getTimeout()


* Visibility: **public**


### useSecure

    mixed MCAPI::useSecure($val)


* Visibility: **public**


#### Arguments
* $val **mixed**


### campaignUnschedule

    boolean MCAPI::campaignUnschedule(string $cid)

Unschedule a campaign that is scheduled to be sent in the future


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the id of the campaign to unschedule&lt;/p&gt;


### campaignSchedule

    boolean MCAPI::campaignSchedule(string $cid, string $schedule_time, string $schedule_time_b)

Schedule a campaign to be sent in the future


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the id of the campaign to schedule&lt;/p&gt;
* $schedule_time **string** - &lt;p&gt;the time to schedule the campaign. For A/B Split &quot;schedule&quot; campaigns, the time for Group A - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;&lt;/p&gt;
* $schedule_time_b **string** - &lt;p&gt;optional -the time to schedule Group B of an A/B Split &quot;schedule&quot; campaign  - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;&lt;/p&gt;


### campaignScheduleBatch

    boolean MCAPI::campaignScheduleBatch(string $cid, string $schedule_time, integer $num_batches, integer $stagger_mins)

Schedule a campaign to be sent in batches sometime in the future. Only valid for "regular" campaigns


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the id of the campaign to schedule&lt;/p&gt;
* $schedule_time **string** - &lt;p&gt;the time to schedule the campaign.&lt;/p&gt;
* $num_batches **integer** - &lt;p&gt;optional - the number of batches between 2 and 26 to send. defaults to 2&lt;/p&gt;
* $stagger_mins **integer** - &lt;p&gt;optional - the number of minutes between each batch - 5, 10, 15, 20, 25, 30, or 60. defaults to 5&lt;/p&gt;


### campaignResume

    boolean MCAPI::campaignResume(string $cid)

Resume sending an AutoResponder or RSS campaign


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the id of the campaign to pause&lt;/p&gt;


### campaignPause

    boolean MCAPI::campaignPause(string $cid)

Pause an AutoResponder or RSS campaign from sending


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the id of the campaign to pause&lt;/p&gt;


### campaignSendNow

    boolean MCAPI::campaignSendNow(string $cid)

Send a given campaign immediately. For RSS campaigns, this will "start" them.


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the id of the campaign to send&lt;/p&gt;


### campaignSendTest

    boolean MCAPI::campaignSendTest(string $cid, array $test_emails, string $send_type)

Send a test of this campaign to the provided email address


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the id of the campaign to test&lt;/p&gt;
* $test_emails **array** - &lt;p&gt;an array of email address to receive the test message&lt;/p&gt;
* $send_type **string** - &lt;p&gt;optional by default (null) both formats are sent - &quot;html&quot; or &quot;text&quot; send just that format&lt;/p&gt;


### campaignSegmentTest

    integer MCAPI::campaignSegmentTest(string $list_id, array $options)

Allows one to test their segmentation rules before creating a campaign using them


* Visibility: **public**


#### Arguments
* $list_id **string** - &lt;p&gt;the list to test segmentation on - get lists using lists()&lt;/p&gt;
* $options **array** - &lt;p&gt;with 2 keys:
string &quot;match&quot; controls whether to use AND or OR when applying your options - expects &quot;&lt;strong&gt;any&lt;/strong&gt;&quot; (for OR) or &quot;&lt;strong&gt;all&lt;/strong&gt;&quot; (for AND)
array &quot;conditions&quot; - up to 10 different criteria to apply while segmenting. Each criteria row must contain 3 keys - &quot;&lt;strong&gt;field&lt;/strong&gt;&quot;, &quot;&lt;strong&gt;op&lt;/strong&gt;&quot;, and &quot;&lt;strong&gt;value&lt;/strong&gt;&quot; - and possibly a fourth, &quot;&lt;strong&gt;extra&lt;/strong&gt;&quot;, based on these definitions:&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;date&lt;/strong&gt;&quot; : Select based on signup date
Valid Op(eration): &lt;strong&gt;eq&lt;/strong&gt; (is) / &lt;strong&gt;gt&lt;/strong&gt; (after) / &lt;strong&gt;lt&lt;/strong&gt; (before)
Valid Values:
string last_campaign_sent  uses the date of the last campaign sent
string campaign_id  uses the send date of the campaign that carriers the Id submitted - see campaigns()
string YYYY-MM-DD  any date in the form of YYYY-MM-DD - &lt;em&gt;note:&lt;/em&gt; anything that appears to start with YYYY will be treated as a date&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;last_changed&lt;/strong&gt;&quot; : Select based on subscriber record last changed date
Valid Op(eration): &lt;strong&gt;eq&lt;/strong&gt; (is) / &lt;strong&gt;gt&lt;/strong&gt; (after) / &lt;strong&gt;lt&lt;/strong&gt; (before)
Valid Values:
string last_campaign_sent  uses the date of the last campaign sent
string campaign_id   uses the send date of the campaign that carriers the Id submitted - see campaigns()
string YYYY-MM-DD   any date in the form of YYYY-MM-DD - &lt;em&gt;note:&lt;/em&gt; anything that appears to start with YYYY will be treated as a date&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;interests-X&lt;/strong&gt;&quot;: where X is the Grouping Id from listInterestGroupings()
Valid Op(erations): &lt;strong&gt;one&lt;/strong&gt; / &lt;strong&gt;none&lt;/strong&gt; / &lt;strong&gt;all&lt;/strong&gt;
Valid Values: a comma delimited string of interest groups for the list, just like you&#039;d use in listSubscribe() - see listInterestGroupings()&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;mc_language&lt;/strong&gt;&quot;: Select subscribers based on their set/auto-detected language
Valid Op(eration): &lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt; (!=)
Valid Values: a case sensitive language code from &lt;a href=&quot;http://kb.mailchimp.com/article/can-i-see-what-languages-my-subscribers-use#code&quot; target=&quot;_new&quot;&gt;here&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;aim&lt;/strong&gt;&quot;
Valid Op(erations): &lt;strong&gt;open&lt;/strong&gt; / &lt;strong&gt;noopen&lt;/strong&gt; / &lt;strong&gt;click&lt;/strong&gt; / &lt;strong&gt;noclick&lt;/strong&gt;
Valid Values: &quot;&lt;strong&gt;any&lt;/strong&gt;&quot; or a valid AIM-enabled Campaign that has been sent&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;rating&lt;/strong&gt;&quot; : allows matching based on list member ratings
Valid Op(erations):  &lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt; (!=) / &lt;strong&gt;gt&lt;/strong&gt; (&amp;gt;) / &lt;strong&gt;lt&lt;/strong&gt; (&amp;lt;)
Valid Values: a number between 0 and 5&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;ecomm_prod&lt;/strong&gt;&quot; or &quot;&lt;strong&gt;ecomm_prod&lt;/strong&gt;&quot;: allows matching product and category names from purchases
Valid Op(erations):
&lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt; (!=) / &lt;strong&gt;gt&lt;/strong&gt; (&amp;gt;) / &lt;strong&gt;lt&lt;/strong&gt; (&amp;lt;) / &lt;strong&gt;like&lt;/strong&gt; (like &#039;%blah%&#039;) / &lt;strong&gt;nlike&lt;/strong&gt; (not like &#039;%blah%&#039;) / &lt;strong&gt;starts&lt;/strong&gt; (like &#039;blah%&#039;) / &lt;strong&gt;ends&lt;/strong&gt; (like &#039;%blah&#039;)
Valid Values: any string&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;ecomm_spent_one&lt;/strong&gt;&quot; or &quot;&lt;strong&gt;ecomm_spent_all&lt;/strong&gt;&quot; : allows matching purchase amounts on a single order or all orders
Valid Op(erations): &lt;strong&gt;gt&lt;/strong&gt; (&amp;gt;) / &lt;strong&gt;lt&lt;/strong&gt; (&amp;lt;)
Valid Values: a number&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;ecomm_date&lt;/strong&gt;&quot; : allow matching based on order dates
Valid Op(eration): &lt;strong&gt;eq&lt;/strong&gt; (is) / &lt;strong&gt;gt&lt;/strong&gt; (after) / &lt;strong&gt;lt&lt;/strong&gt; (before)
Valid Values:
string last_campaign_sent  uses the date of the last campaign sent
string campaign_id  uses the send date of the campaign that carriers the Id submitted - see campaigns()
string YYYY-MM-DD  any date in the form of YYYY-MM-DD - &lt;em&gt;note:&lt;/em&gt; anything that appears to start with YYYY will be treated as a date&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;social_gender&lt;/strong&gt;&quot; : allows matching against the gender acquired from SocialPro
Valid Op(eration): &lt;strong&gt;eq&lt;/strong&gt; (is) / &lt;strong&gt;ne&lt;/strong&gt; (is not)
Valid Values: male, female&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;social_age&lt;/strong&gt;&quot; : allows matching against the age acquired from SocialPro
Valid Op(erations):  &lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt; (!=) / &lt;strong&gt;gt&lt;/strong&gt; (&amp;gt;) / &lt;strong&gt;lt&lt;/strong&gt; (&amp;lt;)
Valid Values: any number&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;social_influence&lt;/strong&gt;&quot; : allows matching against the influence acquired from SocialPro
Valid Op(erations):  &lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt; (!=) / &lt;strong&gt;gt&lt;/strong&gt; (&amp;gt;) / &lt;strong&gt;lt&lt;/strong&gt; (&amp;lt;)
Valid Values: a number between 0 and 5&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;social_network&lt;/strong&gt;&quot; :
Valid Op(erations):  &lt;strong&gt;member&lt;/strong&gt; (is a member of) / &lt;strong&gt;notmember&lt;/strong&gt; (is not a member of)
Valid Values: twitter, facebook, myspace, linkedin, flickr&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;static_segment&lt;/strong&gt;&quot; :
Valid Op(erations): &lt;strong&gt;eq&lt;/strong&gt; (is in) / &lt;strong&gt;ne&lt;/strong&gt; (is not in)
Valid Values: an int  get from listStaticSegments()&lt;/p&gt;
&lt;p&gt;Field = &quot;&lt;strong&gt;default_location&lt;/strong&gt;&quot; : the location we automatically assign to a subscriber based on where we&#039;ve seen their activity originate
Valid Op(erations): &lt;strong&gt;ipgeostate&lt;/strong&gt; (within a US state) / &lt;strong&gt;ipgeonotstate&lt;/strong&gt; (not within a US state) / &lt;strong&gt;ipgeocountry&lt;/strong&gt; (within a country) / &lt;strong&gt;ipgeonotcountry&lt;/strong&gt; (not within a country) / &lt;strong&gt;ipgeoin&lt;/strong&gt; (within lat/lng parameters) / &lt;strong&gt;ipgeonotin&lt;/strong&gt; (not within lat/lng parameters)
Valid Values:
string ipgeostate/ipgeonotstate  a full US state name (not case sensitive)
string ipgeocountry/ipgeonotcountry  an ISO3166 2 digit country code (not case sensitive)
int ipgeoin/ipgeonotin a distance in miles centered around a point you must specify by also passing &lt;strong&gt;lat&lt;/strong&gt; (latitude) and &lt;strong&gt;lng&lt;/strong&gt; (longitude) parameters&lt;/p&gt;
&lt;p&gt;Field = A &lt;strong&gt;Birthday&lt;/strong&gt; type Merge Var. Use &lt;strong&gt;Merge0-Merge30&lt;/strong&gt; or the &lt;strong&gt;Custom Tag&lt;/strong&gt; you&#039;ve setup for your merge field - see listMergeVars(). Note, Brithday fields can &lt;strong&gt;only&lt;/strong&gt; use the operations listed here.
Valid Op(erations): &lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;starts&lt;/strong&gt; (month equals) / &lt;strong&gt;ends&lt;/strong&gt; (day equals)
Valid Values: Any valid number for the operation being checked.&lt;/p&gt;
&lt;p&gt;Field = A &lt;strong&gt;Zip&lt;/strong&gt; type Merge Var. Use &lt;strong&gt;Merge0-Merge30&lt;/strong&gt; or the &lt;strong&gt;Custom Tag&lt;/strong&gt; you&#039;ve setup for your merge field - see listMergeVars(). Note, Zip fields can &lt;strong&gt;only&lt;/strong&gt; use the operations listed here.
Valid Op(erations): &lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt; (!=) / &lt;strong&gt;geoin&lt;/strong&gt; (US only)
Valid Values: For &lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt;, a Zip Code. For &lt;strong&gt;geoin&lt;/strong&gt;, a radius in miles
Extra Value: Only for &lt;strong&gt;geoin&lt;/strong&gt; - the Zip Code to be used as the center point&lt;/p&gt;
&lt;p&gt;Field = An &lt;strong&gt;Address&lt;/strong&gt; type Merge Var. Use &lt;strong&gt;Merge0-Merge30&lt;/strong&gt; or the &lt;strong&gt;Custom Tag&lt;/strong&gt; you&#039;ve setup for your merge field - see listMergeVars(). Note, Address fields can &lt;strong&gt;only&lt;/strong&gt; use the operations listed here.
Valid Op(erations): &lt;strong&gt;like&lt;/strong&gt; (like &#039;%blah%&#039;) / &lt;strong&gt;nlike&lt;/strong&gt; (not like &#039;%blah%&#039;) / &lt;strong&gt;geoin&lt;/strong&gt;
Valid Values: For &lt;strong&gt;like&lt;/strong&gt; and &lt;strong&gt;nlike&lt;/strong&gt;, a string. For &lt;strong&gt;geoin&lt;/strong&gt;, a radius in miles
Extra Value: Only for &lt;strong&gt;geoin&lt;/strong&gt; - the Zip Code to be used as the center point&lt;/p&gt;
&lt;p&gt;Field = A &lt;strong&gt;Number&lt;/strong&gt; type Merge Var. Use &lt;strong&gt;Merge0-Merge30&lt;/strong&gt; or the &lt;strong&gt;Custom Tag&lt;/strong&gt; you&#039;ve setup for your merge field - see listMergeVars(). Note, Number fields can &lt;strong&gt;only&lt;/strong&gt; use the operations listed here.
Valid Op(erations): &lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt; (!=) / &lt;strong&gt;gt&lt;/strong&gt; (&gt;) / &lt;strong&gt;lt&lt;/strong&gt; (&lt;) /
Valid Values: Any valid number.&lt;/p&gt;
&lt;p&gt;Default Field = A Merge Var. Use &lt;strong&gt;Merge0-Merge30&lt;/strong&gt; or the &lt;strong&gt;Custom Tag&lt;/strong&gt; you&#039;ve setup for your merge field - see listMergeVars()
Valid Op(erations):
&lt;strong&gt;eq&lt;/strong&gt; (=) / &lt;strong&gt;ne&lt;/strong&gt; (!=) / &lt;strong&gt;gt&lt;/strong&gt; (&amp;gt;) / &lt;strong&gt;lt&lt;/strong&gt; (&amp;lt;) / &lt;strong&gt;like&lt;/strong&gt; (like &#039;%blah%&#039;) / &lt;strong&gt;nlike&lt;/strong&gt; (not like &#039;%blah%&#039;) / &lt;strong&gt;starts&lt;/strong&gt; (like &#039;blah%&#039;) / &lt;strong&gt;ends&lt;/strong&gt; (like &#039;%blah&#039;)
Valid Values: any string&lt;/p&gt;


### campaignCreate

    string MCAPI::campaignCreate(string $type, array $options, array $content, array $segment_opts, array $type_opts)

Create a new draft campaign to send. You <strong>can not</strong> have more than 32,000 campaigns in your account.


* Visibility: **public**


#### Arguments
* $type **string** - &lt;p&gt;the Campaign Type to create - one of &quot;regular&quot;, &quot;plaintext&quot;, &quot;absplit&quot;, &quot;rss&quot;, &quot;auto&quot;&lt;/p&gt;
* $options **array** - &lt;p&gt;a hash of the standard options for this campaign :
string list_id the list to send this campaign to- get lists using lists()
string subject the subject line for your campaign message
string from_email the From: email address for your campaign message
string from_name the From: name for your campaign message (not an email address)
string to_name the To: name recipients will see (not email address)
int template_id optional - use this user-created template to generate the HTML content of the campaign (takes precendence over other template options)
int gallery_template_id optional - use a template from the public gallery to generate the HTML content of the campaign (takes precendence over base template options)
int base_template_id optional - use this a base/start-from-scratch template to generate the HTML content of the campaign
int folder_id optional - automatically file the new campaign in the folder_id passed. Get using folders() - note that Campaigns and Autoresponders have separate folder setupsn
array tracking optional - set which recipient actions will be tracked, as a struct of boolean values with the following keys: &quot;opens&quot;, &quot;html_clicks&quot;, and &quot;text_clicks&quot;.  By default, opens and HTML clicks will be tracked. Click tracking can not be disabled for Free accounts.
string title optional - an internal name to use for this campaign.  By default, the campaign subject will be used.
boolean authenticate optional - set to true to enable SenderID, DomainKeys, and DKIM authentication, defaults to false.
array analytics optional - if provided, use a struct with &quot;service type&quot; as a key and the &quot;service tag&quot; as a value. Use &quot;google&quot; for Google Analytics, &quot;clicktale&quot; for ClickTale, and &quot;gooal&quot; for Goo.al tracking. The &quot;tag&quot; is any custom text (up to 50 characters) that should be included.
boolean auto_footer optional Whether or not we should auto-generate the footer for your content. Mostly useful for content from URLs or Imports
boolean inline_css optional Whether or not css should be automatically inlined when this campaign is sent, defaults to false.
boolean generate_text optional Whether of not to auto-generate your Text content from the HTML content. Note that this will be ignored if the Text part of the content passed is not empty, defaults to false.
boolean auto_tweet optional If set, this campaign will be auto-tweeted when it is sent - defaults to false. Note that if a Twitter account isn&#039;t linked, this will be silently ignored.
array auto_fb_post optional If set, this campaign will be auto-posted to the page_ids contained in the array. If a Facebook account isn&#039;t linked or the account does not have permission to post to the page_ids requested, those failures will be silently ignored.
boolean fb_comments optional If true, the Facebook comments (and thus the &lt;a href=&quot;http://kb.mailchimp.com/article/i-dont-want-an-archiave-of-my-campaign-can-i-turn-it-off/&quot; target=&quot;_blank&quot;&gt;archive bar&lt;/a&gt; will be displayed. If false, Facebook comments will not be enabled (does not imply no archive bar, see previous link). Defaults to &quot;true&quot;.
boolean timewarp optional If set, this campaign must be scheduled 24 hours in advance of sending - default to false. Only valid for &quot;regular&quot; campaigns and &quot;absplit&quot; campaigns that split on schedule_time.
boolean ecomm360 optional If set, our &lt;a href=&quot;http://www.mailchimp.com/blog/ecommerce-tracking-plugin/&quot; target=&quot;_blank&quot;&gt;Ecommerce360 tracking&lt;/a&gt; will be enabled for links in the campaign
array crm_tracking optional If set, enable CRM tracking for:&lt;div style=&quot;padding-left:15px&quot;&gt;&lt;table&gt;
array salesforce optional Enable SalesForce push back&lt;div style=&quot;padding-left:15px&quot;&gt;&lt;table&gt;
bool campaign optional - if true, create a Campaign object and update it with aggregate stats
bool notes  optional - if true, attempt to update Contact notes based on email address&lt;/table&gt;&lt;/div&gt;
array highrise optional Enable Highrise push back&lt;div style=&quot;padding-left:15px&quot;&gt;&lt;table&gt;
bool campaign optional - if true, create a Kase object and update it with aggregate stats
bool notes  optional - if true, attempt to update Contact notes based on email address&lt;/table&gt;&lt;/div&gt;
array capsule optional Enable Capsule push back (only notes are supported)&lt;div style=&quot;padding-left:15px&quot;&gt;&lt;table&gt;
bool notes optional - if true, attempt to update Contact notes based on email address&lt;/table&gt;&lt;/div&gt;&lt;/table&gt;&lt;/div&gt;&lt;/p&gt;
* $content **array** - &lt;p&gt;the content for this campaign - use a struct with the following keys:
string html for pasted HTML content
string text for the plain-text version
string url to have us pull in content from a URL. Note, this will override any other content options - for lists with Email Format options, you&#039;ll need to turn on generate_text as well
string archive to send a Base64 encoded archive file for us to import all media from. Note, this will override any other content options - for lists with Email Format options, you&#039;ll need to turn on generate_text as well
string archive_type optional - only necessary for the &quot;archive&quot; option. Supported formats are: zip, tar.gz, tar.bz2, tar, tgz, tbz . If not included, we will default to zip&lt;/p&gt;
&lt;p&gt;If you chose a template instead of pasting in your HTML content, then use &quot;html_&quot; followed by the template sections as keys - for example, use a key of &quot;html_MAIN&quot; to fill in the &quot;MAIN&quot; section of a template.&lt;/p&gt;
* $segment_opts **array** - &lt;p&gt;optional - if you wish to do Segmentation with this campaign this array should contain: see campaignSegmentTest(). It&#039;s suggested that you test your options against campaignSegmentTest().&lt;/p&gt;
* $type_opts **array** - &lt;p&gt;optional -
For RSS Campaigns this, array should contain:
string url the URL to pull RSS content from - it will be verified and must exist
string schedule optional one of &quot;daily&quot;, &quot;weekly&quot;, &quot;monthly&quot; - defaults to &quot;daily&quot;
string schedule_hour optional an hour between 0 and 24 - default to 4 (4am &lt;em&gt;local time&lt;/em&gt;) - applies to all schedule types
string schedule_weekday optional for &quot;weekly&quot; only, a number specifying the day of the week to send: 0 (Sunday) - 6 (Saturday) - defaults to 1 (Monday)
string schedule_monthday optional for &quot;monthly&quot; only, a number specifying the day of the month to send (1 - 28) or &quot;last&quot; for the last day of a given month. Defaults to the 1st day of the month
array days optional used for &quot;daily&quot; schedules only, an array of the &lt;a href=&quot;http://en.wikipedia.org/wiki/ISO-8601#Week_dates&quot; target=&quot;_blank&quot;&gt;ISO-8601 weekday numbers&lt;/a&gt; to send on&lt;div style=&quot;padding-left:15px&quot;&gt;&lt;table&gt;
bool 1 optional Monday, defaults to true
bool 2 optional Tuesday, defaults to true
bool 3 optional Wednesday, defaults to true
bool 4 optional Thursday, defaults to true
bool 5 optional Friday, defaults to true
bool 6 optional Saturday, defaults to true
bool 7 optional Sunday, defaults to true&lt;/table&gt;&lt;/div&gt;&lt;/p&gt;
&lt;p&gt;For A/B Split campaigns, this array should contain:
string split_test The values to segment based on. Currently, one of: &quot;subject&quot;, &quot;from_name&quot;, &quot;schedule&quot;. NOTE, for &quot;schedule&quot;, you will need to call campaignSchedule() separately!
string pick_winner How the winner will be picked, one of: &quot;opens&quot; (by the open_rate), &quot;clicks&quot; (by the click rate), &quot;manual&quot; (you pick manually)
int wait_units optional the default time unit to wait before auto-selecting a winner - use &quot;3600&quot; for hours, &quot;86400&quot; for days. Defaults to 86400.
int wait_time optional the number of units to wait before auto-selecting a winner - defaults to 1, so if not set, a winner will be selected after 1 Day.
int split_size optional this is a percentage of what size the Campaign&#039;s List plus any segmentation options results in. &quot;schedule&quot; type forces 50%, all others default to 10%
string from_name_a optional sort of, required when split_test is &quot;from_name&quot;
string from_name_b optional sort of, required when split_test is &quot;from_name&quot;
string from_email_a optional sort of, required when split_test is &quot;from_name&quot;
string from_email_b optional sort of, required when split_test is &quot;from_name&quot;
string subject_a optional sort of, required when split_test is &quot;subject&quot;
string subject_b optional sort of, required when split_test is &quot;subject&quot;&lt;/p&gt;
&lt;p&gt;For AutoResponder campaigns, this array should contain:
string offset-units one of &quot;hourly&quot;, &quot;day&quot;, &quot;week&quot;, &quot;month&quot;, &quot;year&quot; - required
string offset-time optional, sort of - the number of units must be a number greater than 0 for signup based autoresponders, ignored for &quot;hourly&quot;
string offset-dir either &quot;before&quot; or &quot;after&quot;, ignored for &quot;hourly&quot;
string event optional &quot;signup&quot; (default) to base this members added to a list, &quot;date&quot;, &quot;annual&quot;, or &quot;birthday&quot; to base this on merge field in the list, &quot;campaignOpen&quot; or &quot;campaignClicka&quot; to base this on any activity for a campaign, &quot;campaignClicko&quot; to base this on clicks on a specific URL in a campaign, &quot;mergeChanged&quot; to base this on a specific merge field being changed to a specific value
string event-datemerge optional sort of, this is required if the event is &quot;date&quot;, &quot;annual&quot;, &quot;birthday&quot;, or &quot;mergeChanged&quot;
string campaign_id optional sort of, required for &quot;campaignOpen&quot;, &quot;campaignClicka&quot;, or &quot;campaignClicko&quot;
string campaign_url optional sort of, required for &quot;campaignClicko&quot;
int schedule_hour The hour of the day - 24 hour format in GMT - the autoresponder should be triggered, ignored for &quot;hourly&quot;
boolean use_import_time whether or not imported subscribers (ie, &lt;em&gt;any&lt;/em&gt; non-double optin subscribers) will receive
array days optional used for &quot;daily&quot; schedules only, an array of the &lt;a href=&quot;http://en.wikipedia.org/wiki/ISO-8601#Week_dates&quot; target=&quot;_blank&quot;&gt;ISO-8601 weekday numbers&lt;/a&gt; to send on&lt;div style=&quot;padding-left:15px&quot;&gt;&lt;table&gt;
bool 1 optional Monday, defaults to true
bool 2 optional Tuesday, defaults to true
bool 3 optional Wednesday, defaults to true
bool 4 optional Thursday, defaults to true
bool 5 optional Friday, defaults to true
bool 6 optional Saturday, defaults to true
bool 7 optional Sunday, defaults to true&lt;/table&gt;&lt;/div&gt;&lt;/p&gt;


### campaignUpdate

    boolean MCAPI::campaignUpdate(string $cid, string $name, mixed $value)

Update just about any setting for a campaign that has <em>not</em> been sent. See campaignCreate() for details.

Caveats:<br/><ul class='simplelist square'>
       <li>If you set list_id, all segmentation options will be deleted and must be re-added.</li>
       <li>If you set template_id, you need to follow that up by setting it's 'content'</li>
       <li>If you set segment_opts, you should have tested your options against campaignSegmentTest() as campaignUpdate() will not allow you to set a segment that includes no members.</li>
       <li>To clear/unset segment_opts, pass an empty string or array as the value. Various wrappers may require one or the other.</li>
</ul>

* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the Campaign Id to update&lt;/p&gt;
* $name **string** - &lt;p&gt;the parameter name ( see campaignCreate() ). For items in the &lt;strong&gt;options&lt;/strong&gt; array, this will be that parameter&#039;s name (subject, from_email, etc.). Additional parameters will be that option name  (content, segment_opts). &quot;type_opts&quot; will be the name of the type - rss, auto, etc.&lt;/p&gt;
* $value **mixed** - &lt;p&gt;an appropriate value for the parameter ( see campaignCreate() ). For items in the &lt;strong&gt;options&lt;/strong&gt; array, this will be that parameter&#039;s value. For additional parameters, this is the same value passed to them.&lt;/p&gt;


### campaignReplicate

    string MCAPI::campaignReplicate(string $cid)

Replicate a campaign.


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the Campaign Id to replicate&lt;/p&gt;


### campaignDelete

    boolean MCAPI::campaignDelete(string $cid)

Delete a campaign. Seriously, "poof, gone!" - be careful!


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the Campaign Id to delete&lt;/p&gt;


### campaigns

    array MCAPI::campaigns(array $filters, integer $start, integer $limit, $sort_field, $sort_dir)

Get the list of campaigns and their details matching the specified filters


* Visibility: **public**


#### Arguments
* $filters **array** - &lt;p&gt;a hash of filters to apply to this query - all are optional:
string campaign_id optional - return the campaign using a know campaign_id.  Accepts multiples separated by commas when not using exact matching.
string parent_id optional - return the child campaigns using a known parent campaign_id.  Accepts multiples separated by commas when not using exact matching.
string list_id optional - the list to send this campaign to - get lists using lists(). Accepts multiples separated by commas when not using exact matching.
int folder_id optional - only show campaigns from this folder id - get folders using campaignFolders(). Accepts multiples separated by commas when not using exact matching.
int template_id optional - only show campaigns using this template id - get templates using templates(). Accepts multiples separated by commas when not using exact matching.
string  status optional - return campaigns of a specific status - one of &quot;sent&quot;, &quot;save&quot;, &quot;paused&quot;, &quot;schedule&quot;, &quot;sending&quot;. Accepts multiples separated by commas when not using exact matching.
string  type optional - return campaigns of a specific type - one of &quot;regular&quot;, &quot;plaintext&quot;, &quot;absplit&quot;, &quot;rss&quot;, &quot;auto&quot;. Accepts multiples separated by commas when not using exact matching.
string  from_name optional - only show campaigns that have this &quot;From Name&quot;
string  from_email optional - only show campaigns that have this &quot;Reply-to Email&quot;
string  title optional - only show campaigns that have this title
string  subject optional - only show campaigns that have this subject
string  sendtime_start optional - only show campaigns that have been sent since this date/time (in GMT) -  - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;
string  sendtime_end optional - only show campaigns that have been sent before this date/time (in GMT) -  - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;
boolean uses_segment - whether to return just campaigns with or without segments
boolean exact optional - flag for whether to filter on exact values when filtering, or search within content for filter values - defaults to true. Using this disables the use of any filters that accept multiples.&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional - control paging of campaigns, start results at this campaign #, defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional - control paging of campaigns, number of campaigns to return with each call, defaults to 25 (max=1000)&lt;/p&gt;
* $sort_field **mixed**
* $sort_dir **mixed**


### campaignStats

    array MCAPI::campaignStats(string $cid)

Given a list and a campaign, get all the relevant campaign statistics (opens, bounces, clicks, etc.)


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull stats for (can be gathered using campaigns())&lt;/p&gt;


### campaignClickStats

    array MCAPI::campaignClickStats(string $cid)

Get an array of the urls being tracked, and their click counts for a given campaign


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull stats for (can be gathered using campaigns())&lt;/p&gt;


### campaignEmailDomainPerformance

    array MCAPI::campaignEmailDomainPerformance(string $cid)

Get the top 5 performing email domains for this campaign. Users want more than 5 should use campaign campaignEmailStatsAIM()
or campaignEmailStatsAIMAll() and generate any additional stats they require.


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull email domain performance for (can be gathered using campaigns())&lt;/p&gt;


### campaignMembers

    array MCAPI::campaignMembers(string $cid, string $status, integer $start, integer $limit)

Get all email addresses the campaign was sent to


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull members for (can be gathered using campaigns())&lt;/p&gt;
* $status **string** - &lt;p&gt;optional the status to pull - one of &#039;sent&#039;, &#039;hard&#039; (bounce), or &#039;soft&#039; (bounce). By default, all records are returned&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000&lt;/p&gt;


### campaignHardBounces

    array MCAPI::campaignHardBounces(string $cid, integer $start, integer $limit)

<strong>DEPRECATED</strong> Get all email addresses with Hard Bounces for a given campaign


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000&lt;/p&gt;


### campaignSoftBounces

    array MCAPI::campaignSoftBounces(string $cid, integer $start, integer $limit)

<strong>DEPRECATED</strong> Get all email addresses with Soft Bounces for a given campaign


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000&lt;/p&gt;


### campaignUnsubscribes

    array MCAPI::campaignUnsubscribes(string $cid, integer $start, integer $limit)

Get all unsubscribed email addresses for a given campaign


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000&lt;/p&gt;


### campaignAbuseReports

    array MCAPI::campaignAbuseReports(string $cid, string $since, integer $start, integer $limit)

Get all email addresses that complained about a given campaign


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull abuse reports for (can be gathered using campaigns())&lt;/p&gt;
* $since **string** - &lt;p&gt;optional pull only messages since this time - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 500, upper limit set at 1000&lt;/p&gt;


### campaignAdvice

    array MCAPI::campaignAdvice(string $cid)

Retrieve the text presented in our app for how a campaign performed and any advice we may have for you - best
suited for display in customized reports pages. Note: some messages will contain HTML - clean tags as necessary


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull advice text for (can be gathered using campaigns())&lt;/p&gt;


### campaignAnalytics

    array MCAPI::campaignAnalytics(string $cid)

Retrieve the Google Analytics data we've collected for this campaign. Note, requires Google Analytics Add-on to be installed and configured.


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;


### campaignGeoOpens

    array MCAPI::campaignGeoOpens(string $cid)

Retrieve the countries and number of opens tracked for each. Email address are not returned.


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;


### campaignGeoOpensForCountry

    array MCAPI::campaignGeoOpensForCountry(string $cid, string $code)

Retrieve the regions and number of opens tracked for a certain country. Email address are not returned.


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;
* $code **string** - &lt;p&gt;An ISO3166 2 digit country code&lt;/p&gt;


### campaignEepUrlStats

    array MCAPI::campaignEepUrlStats(string $cid)

Retrieve the tracked eepurl mentions on Twitter


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;


### campaignBounceMessage

    array MCAPI::campaignBounceMessage(string $cid, string $email)

Retrieve the most recent full bounce message for a specific email address on the given campaign.

Messages over 30 days old are subject to being removed

* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;
* $email **string** - &lt;p&gt;the email address or unique id of the member to pull a bounce message for.&lt;/p&gt;


### campaignBounceMessages

    array MCAPI::campaignBounceMessages(string $cid, integer $start, integer $limit, string $since)

Retrieve the full bounce messages for the given campaign. Note that this can return very large amounts
of data depending on how large the campaign was and how much cruft the bounce provider returned. Also,
message over 30 days old are subject to being removed


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 25, upper limit set at 50&lt;/p&gt;
* $since **string** - &lt;p&gt;optional pull only messages since this time - use YYYY-MM-DD format in &lt;strong&gt;GMT&lt;/strong&gt; (we only store the date, not the time)&lt;/p&gt;


### campaignEcommOrders

    array MCAPI::campaignEcommOrders(string $cid, integer $start, integer $limit, string $since)

Retrieve the Ecommerce Orders tracked by campaignEcommOrderAdd()


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to pull bounces for (can be gathered using campaigns())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 100, upper limit set at 500&lt;/p&gt;
* $since **string** - &lt;p&gt;optional pull only messages since this time - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;&lt;/p&gt;


### campaignShareReport

    array MCAPI::campaignShareReport(string $cid, array $opts)

Get the URL to a customized <a href="http://eepurl.com/gKmL" target="_blank">VIP Report</a> for the specified campaign and optionally send an email to someone with links to it. Note subsequent calls will overwrite anything already set for the same campign (eg, the password)


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to share a report for (can be gathered using campaigns())&lt;/p&gt;
* $opts **array** - &lt;p&gt;optional various parameters which can be used to configure the shared report
string to_email optional - optional, comma delimited list of email addresses to share the report with - no value means an email will not be sent
string company optional - a company name to be displayed (use of a theme may hide this) - max 255 bytes
int theme_id optional - either a global or a user-specific theme id. Currently this needs to be pulled out of either the Share Report or Cobranding web views by grabbing the &quot;theme&quot; attribute from the list presented.
string  css_url    optional - a link to an external CSS file to be included after our default CSS (&lt;a href=&quot;http://vip-reports.net/css/vip.css&quot;&gt;http://vip-reports.net/css/vip.css&lt;/a&gt;) &lt;strong&gt;only if&lt;/strong&gt; loaded via the &quot;secure_url&quot; - max 255 bytes&lt;/p&gt;


### campaignContent

    array MCAPI::campaignContent(string $cid, boolean $for_archive)

Get the content (both html and text) for a campaign either as it would appear in the campaign archive or as the raw, original content


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to get content for (can be gathered using campaigns())&lt;/p&gt;
* $for_archive **boolean** - &lt;p&gt;optional controls whether we return the Archive version (true) or the Raw version (false), defaults to true&lt;/p&gt;


### campaignTemplateContent

    array MCAPI::campaignTemplateContent(string $cid)

Get the HTML template content sections for a campaign. Note that this <strong>will</strong> return very jagged, non-standard results based on the template
a campaign is using. You only want to use this if you want to allow editing template sections in your applicaton.


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to get content for (can be gathered using campaigns())&lt;/p&gt;


### campaignOpenedAIM

    array MCAPI::campaignOpenedAIM(string $cid, integer $start, integer $limit)

Retrieve the list of email addresses that opened a given campaign with how many times they opened


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to get opens for (can be gathered using campaigns())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000&lt;/p&gt;


### campaignNotOpenedAIM

    array MCAPI::campaignNotOpenedAIM(string $cid, integer $start, integer $limit)

Retrieve the list of email addresses that did not open a given campaign


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to get no opens for (can be gathered using campaigns())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000&lt;/p&gt;


### campaignClickDetailAIM

    array MCAPI::campaignClickDetailAIM(string $cid, string $url, integer $start, integer $limit)

Return the list of email addresses that clicked on a given url, and how many times they clicked


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to get click stats for (can be gathered using campaigns())&lt;/p&gt;
* $url **string** - &lt;p&gt;the URL of the link that was clicked on&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000&lt;/p&gt;


### campaignEmailStatsAIM

    array MCAPI::campaignEmailStatsAIM(string $cid, array $email_address)

Given a campaign and email address, return the entire click and open history with timestamps, ordered by time


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to get stats for (can be gathered using campaigns())&lt;/p&gt;
* $email_address **array** - &lt;p&gt;an array of up to 50 email addresses to check OR the email &quot;id&quot; returned from listMemberInfo, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC).&lt;/p&gt;


### campaignEmailStatsAIMAll

    array MCAPI::campaignEmailStatsAIMAll(string $cid, integer $start, integer $limit)

Given a campaign and correct paging limits, return the entire click and open history with timestamps, ordered by time,
for every user a campaign was delivered to.


* Visibility: **public**


#### Arguments
* $cid **string** - &lt;p&gt;the campaign id to get stats for (can be gathered using campaigns())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 100, upper limit set at 1000&lt;/p&gt;


### campaignEcommOrderAdd

    boolean MCAPI::campaignEcommOrderAdd(array $order)

Attach Ecommerce Order Information to a Campaign. This will generally be used by ecommerce package plugins
<a href="http://connect.mailchimp.com/category/ecommerce" target="_blank">provided by us or by 3rd part system developers</a>.


* Visibility: **public**


#### Arguments
* $order **array** - &lt;p&gt;an array of information pertaining to the order that has completed. Use the following keys:
string id the Order Id
string campaign_id the Campaign Id to track this order with (see the &quot;mc_cid&quot; query string variable a campaign passes)
string email_id the Email Id of the subscriber we should attach this order to (see the &quot;mc_eid&quot; query string variable a campaign passes)
double total The Order Total (ie, the full amount the customer ends up paying)
string order_date optional the date of the order - if this is not provided, we will default the date to now
double shipping optional the total paid for Shipping Fees
double tax optional the total tax paid
string store_id a unique id for the store sending the order in (20 bytes max)
string store_name optional a &quot;nice&quot; name for the store - typically the base web address (ie, &quot;store.mailchimp.com&quot;). We will automatically update this if it changes (based on store_id)
array items the individual line items for an order using these keys:&lt;/p&gt;
&lt;div style=&quot;padding-left:30px&quot;&gt;&lt;table&gt;
int line_num optional the line number of the item on the order. We will generate these if they are not passed
int product_id the store&#039;s internal Id for the product. Lines that do no contain this will be skipped
string sku optional the store&#039;s internal SKU for the product. (max 30 bytes)
string product_name the product name for the product_id associated with this item. We will auto update these as they change (based on product_id)
int category_id the store&#039;s internal Id for the (main) category associated with this product. Our testing has found this to be a &quot;best guess&quot; scenario
string category_name the category name for the category_id this product is in. Our testing has found this to be a &quot;best guess&quot; scenario. Our plugins walk the category heirarchy up and send &quot;Root - SubCat1 - SubCat4&quot;, etc.
double qty the quantity of the item ordered
double cost the cost of a single item (ie, not the extended cost of the line)
&lt;/table&gt;&lt;/div&gt;


### lists

    array MCAPI::lists(array $filters, integer $start, integer $limit, $sort_field, $sort_dir)

Retrieve all of the lists defined for your user account


* Visibility: **public**


#### Arguments
* $filters **array** - &lt;p&gt;a hash of filters to apply to this query - all are optional:
string list_id optional - return a single list using a known list_id. Accepts multiples separated by commas when not using exact matching
string list_name optional - only lists that match this name
string from_name optional - only lists that have a default from name matching this
string from_email optional - only lists that have a default from email matching this
string from_subject optional - only lists that have a default from email matching this
string created_before optional - only show lists that were created before this date/time  - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;
string created_after optional - only show lists that were created since this date/time  - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;
boolean exact optional - flag for whether to filter on exact values when filtering, or search within content for filter values - defaults to true&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional - control paging of lists, start results at this list #, defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional - control paging of lists, number of lists to return with each call, defaults to 25 (max=100)&lt;/p&gt;
* $sort_field **mixed**
* $sort_dir **mixed**


### listMergeVars

    array MCAPI::listMergeVars(string $id)

Get the list of merge tags for a given list, including their name, tag, and required setting


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;


### listMergeVarAdd

    boolean MCAPI::listMergeVarAdd(string $id, string $tag, string $name, array $options)

Add a new merge tag to a given list


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $tag **string** - &lt;p&gt;The merge tag to add, e.g. FNAME. 10 bytes max, valid characters: &quot;A-Z 0-9 _&quot; no spaces, dashes, etc.&lt;/p&gt;
* $name **string** - &lt;p&gt;The long description of the tag being added, used for user displays&lt;/p&gt;
* $options **array** - &lt;p&gt;optional Various options for this merge var. &lt;em&gt;note:&lt;/em&gt; for historical purposes this can also take a &quot;boolean&quot;
string field_type optional one of: text, number, radio, dropdown, date, address, phone, url, imageurl, zip, birthday - defaults to text
boolean req optional indicates whether the field is required - defaults to false
boolean public optional indicates whether the field is displayed in public - defaults to true
boolean show optional indicates whether the field is displayed in the app&#039;s list member view - defaults to true
int order The order this merge tag should be displayed in - this will cause existing values to be reset so this fits
string default_value optional the default value for the field. See listSubscribe() for formatting info. Defaults to blank
array choices optional kind of - an array of strings to use as the choices for radio and dropdown type fields
string dateformat optional only valid for birthday and date fields. For birthday type, must be &quot;MM/DD&quot; (default) or &quot;DD/MM&quot;. For date type, must be &quot;MM/DD/YYYY&quot; (default) or &quot;DD/MM/YYYY&quot;. Any other values will be converted to the default.
string phoneformat optional &quot;US&quot; is the default - any other value will cause them to be unformatted (international)
string defaultcountry optional the &lt;a href=&quot;http://www.iso.org/iso/english_country_names_and_code_elements&quot; target=&quot;_blank&quot;&gt;ISO 3166 2 digit character code&lt;/a&gt; for the default country. Defaults to &quot;US&quot;. Anything unrecognized will be converted to the default.&lt;/p&gt;


### listMergeVarUpdate

    boolean MCAPI::listMergeVarUpdate(string $id, string $tag, array $options)

Update most parameters for a merge tag on a given list. You cannot currently change the merge type


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $tag **string** - &lt;p&gt;The merge tag to update&lt;/p&gt;
* $options **array** - &lt;p&gt;The options to change for a merge var. See listMergeVarAdd() for valid options. &quot;tag&quot; and &quot;name&quot; may also be used here.&lt;/p&gt;


### listMergeVarDel

    boolean MCAPI::listMergeVarDel(string $id, string $tag)

Delete a merge tag from a given list and all its members. Seriously - the data is removed from all members as well!
Note that on large lists this method may seem a bit slower than calls you typically make.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $tag **string** - &lt;p&gt;The merge tag to delete&lt;/p&gt;


### listMergeVarReset

    boolean MCAPI::listMergeVarReset(string $id, string $tag)

Completely resets all data stored in a merge var on a list. All data is removed and this action can not be undone.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $tag **string** - &lt;p&gt;The merge tag to reset&lt;/p&gt;


### listInterestGroupings

    \struct MCAPI::listInterestGroupings(string $id)

Get the list of interest groupings for a given list, including the label, form information, and included groups for each


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;


### listInterestGroupAdd

    boolean MCAPI::listInterestGroupAdd(string $id, string $group_name, integer $grouping_id)

Add a single Interest Group - if interest groups for the List are not yet enabled, adding the first
 group will automatically turn them on.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $group_name **string** - &lt;p&gt;the interest group to add - group names must be unique within a grouping&lt;/p&gt;
* $grouping_id **integer** - &lt;p&gt;optional The grouping to add the new group to - get using listInterestGrouping() . If not supplied, the first grouping on the list is used.&lt;/p&gt;


### listInterestGroupDel

    boolean MCAPI::listInterestGroupDel(string $id, string $group_name, integer $grouping_id)

Delete a single Interest Group - if the last group for a list is deleted, this will also turn groups for the list off.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $group_name **string** - &lt;p&gt;the interest group to delete&lt;/p&gt;
* $grouping_id **integer** - &lt;p&gt;The grouping to delete the group from - get using listInterestGrouping() . If not supplied, the first grouping on the list is used.&lt;/p&gt;


### listInterestGroupUpdate

    boolean MCAPI::listInterestGroupUpdate(string $id, string $old_name, string $new_name, integer $grouping_id)

Change the name of an Interest Group


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $old_name **string** - &lt;p&gt;the interest group name to be changed&lt;/p&gt;
* $new_name **string** - &lt;p&gt;the new interest group name to be set&lt;/p&gt;
* $grouping_id **integer** - &lt;p&gt;optional The grouping to delete the group from - get using listInterestGrouping() . If not supplied, the first grouping on the list is used.&lt;/p&gt;


### listInterestGroupingAdd

    integer MCAPI::listInterestGroupingAdd(string $id, string $name, string $type, array $groups)

Add a new Interest Grouping - if interest groups for the List are not yet enabled, adding the first
 grouping will automatically turn them on.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $name **string** - &lt;p&gt;the interest grouping to add - grouping names must be unique&lt;/p&gt;
* $type **string** - &lt;p&gt;The type of the grouping to add - one of &quot;checkboxes&quot;, &quot;hidden&quot;, &quot;dropdown&quot;, &quot;radio&quot;&lt;/p&gt;
* $groups **array** - &lt;p&gt;The lists of initial group names to be added - at least 1 is required and the names must be unique within a grouping. If the number takes you over the 60 group limit, an error will be thrown.&lt;/p&gt;


### listInterestGroupingUpdate

    boolean MCAPI::listInterestGroupingUpdate(integer $grouping_id, string $name, string $value)

Update an existing Interest Grouping


* Visibility: **public**


#### Arguments
* $grouping_id **integer** - &lt;p&gt;the interest grouping id - get from listInterestGroupings()&lt;/p&gt;
* $name **string** - &lt;p&gt;The name of the field to update - either &quot;name&quot; or &quot;type&quot;. Groups with in the grouping should be manipulated using the standard listInterestGroup* methods&lt;/p&gt;
* $value **string** - &lt;p&gt;The new value of the field. Grouping names must be unique - only &quot;hidden&quot; and &quot;checkboxes&quot; grouping types can be converted between each other.&lt;/p&gt;


### listInterestGroupingDel

    boolean MCAPI::listInterestGroupingDel(integer $grouping_id)

Delete an existing Interest Grouping - this will permanently delete all contained interest groups and will remove those selections from all list members


* Visibility: **public**


#### Arguments
* $grouping_id **integer** - &lt;p&gt;the interest grouping id - get from listInterestGroupings()&lt;/p&gt;


### listWebhooks

    array MCAPI::listWebhooks(string $id)

Return the Webhooks configured for the given list


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;


### listWebhookAdd

    boolean MCAPI::listWebhookAdd(string $id, string $url, array $actions, array $sources)

Add a new Webhook URL for the given list


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $url **string** - &lt;p&gt;a valid URL for the Webhook - it will be validated. note that a url may only exist on a list once.&lt;/p&gt;
* $actions **array** - &lt;p&gt;optional a hash of actions to fire this Webhook for
bool subscribe optional as subscribes occur, defaults to true
bool unsubscribe optional as subscribes occur, defaults to true
bool profile optional as profile updates occur, defaults to true
bool cleaned optional as emails are cleaned from the list, defaults to true
bool upemail optional when  subscribers change their email address, defaults to true
bool campaign option when a campaign is sent or canceled, defaults to true&lt;/p&gt;
* $sources **array** - &lt;p&gt;optional a hash of sources to fire this Webhook for
bool user optional user/subscriber initiated actions, defaults to true
bool admin optional admin actions in our web app, defaults to true
bool api optional actions that happen via API calls, defaults to false&lt;/p&gt;


### listWebhookDel

    boolean MCAPI::listWebhookDel(string $id, string $url)

Delete an existing Webhook URL from a given list


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $url **string** - &lt;p&gt;the URL of a Webhook on this list&lt;/p&gt;


### listStaticSegments

    array MCAPI::listStaticSegments(string $id)

Retrieve all of the Static Segments for a list.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;


### listStaticSegmentAdd

    integer MCAPI::listStaticSegmentAdd(string $id, string $name)

Save a segment against a list for later use. There is no limit to the number of segments which can be saved. Static Segments <strong>are not</strong> tied
 to any merge data, interest groups, etc. They essentially allow you to configure an unlimited number of custom segments which will have standard performance.

When using proper segments, Static Segments are one of the available options for segmentation just as if you used a merge var (and they can be used with other segmentation
 options), though performance may degrade at that point.

* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $name **string** - &lt;p&gt;a unique name per list for the segment - 50 byte maximum length, anything longer will throw an error&lt;/p&gt;


### listStaticSegmentReset

    boolean MCAPI::listStaticSegmentReset(string $id, integer $seg_id)

Resets a static segment - removes <strong>all</strong> members from the static segment. Note: does not actually affect list member data


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $seg_id **integer** - &lt;p&gt;the id of the static segment to reset  - get from listStaticSegments()&lt;/p&gt;


### listStaticSegmentDel

    boolean MCAPI::listStaticSegmentDel(string $id, integer $seg_id)

Delete a static segment. Note that this will, of course, remove any member affiliations with the segment


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $seg_id **integer** - &lt;p&gt;the id of the static segment to delete - get from listStaticSegments()&lt;/p&gt;


### listStaticSegmentMembersAdd

    array MCAPI::listStaticSegmentMembersAdd(string $id, integer $seg_id, array $batch)

Add list members to a static segment. It is suggested that you limit batch size to no more than 10,000 addresses per call. Email addresses must exist on the list
 in order to be included - this <strong>will not</strong> subscribe them to the list!


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $seg_id **integer** - &lt;p&gt;the id of the static segment to modify - get from listStaticSegments()&lt;/p&gt;
* $batch **array** - &lt;p&gt;an array of email addresses and/or unique_ids to add to the segment&lt;/p&gt;


### listStaticSegmentMembersDel

    array MCAPI::listStaticSegmentMembersDel(string $id, integer $seg_id, array $batch)

Remove list members from a static segment. It is suggested that you limit batch size to no more than 10,000 addresses per call. Email addresses must exist on the list
 in order to be removed - this <strong>will not</strong> unsubscribe them from the list!


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $seg_id **integer** - &lt;p&gt;the id of the static segment to delete - get from listStaticSegments()&lt;/p&gt;
* $batch **array** - &lt;p&gt;an array of email addresses and/or unique_ids to remove from the segment&lt;/p&gt;


### listSubscribe

    boolean MCAPI::listSubscribe(string $id, string $email_address, array $merge_vars, string $email_type, boolean $double_optin, boolean $update_existing, boolean $replace_interests, boolean $send_welcome)

Subscribe the provided email to a list. By default this sends a confirmation email - you will not see new members until the link contained in it is clicked!


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $email_address **string** - &lt;p&gt;the email address to subscribe&lt;/p&gt;
* $merge_vars **array** - &lt;p&gt;optional merges for the email (FNAME, LNAME, etc.) (see examples below for handling &quot;blank&quot; arrays). Note that a merge field can only hold up to 255 bytes. Also, there are a few &quot;special&quot; keys:
string EMAIL set this to change the email address. This is only respected on calls using update_existing or when passed to listUpdateMember()
string NEW-EMAIL set this to change the email address. This is only respected on calls using update_existing or when passed to listUpdateMember(). Required to change via listBatchSubscribe() - EMAIL takes precedence on other calls, though either will work.
array GROUPINGS Set Interest Groups by Grouping. Each element in this array should be an array containing the &quot;groups&quot; parameter which contains a comma delimited list of Interest Groups to add. Commas in Interest Group names should be escaped with a backslash. ie, &quot;,&quot; =&amp;gt; &quot;\,&quot; and either an &quot;id&quot; or &quot;name&quot; parameter to specify the Grouping - get from listInterestGroupings()
string OPTIN_IP Set the Opt-in IP field. &lt;em&gt;Abusing this may cause your account to be suspended.&lt;/em&gt; We do validate this and it must not be a private IP address.
string OPTIN_TIME Set the Opt-in Time field. &lt;em&gt;Abusing this may cause your account to be suspended.&lt;/em&gt; We do validate this and it must be a valid date. Use  - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot; to be safe. Generally, though, anything strtotime() understands we&#039;ll understand - &lt;a href=&quot;http://us2.php.net/strtotime&quot; target=&quot;_blank&quot;&gt;&lt;a href=&quot;http://us2.php.net/strtotime&quot;&gt;http://us2.php.net/strtotime&lt;/a&gt;&lt;/a&gt;
array MC_LOCATION Set the member&#039;s geographic location. By default if this merge field exists, we&#039;ll update using the optin_ip if it exists. If the array contains LATITUDE and LONGITUDE keys, they will be used. NOTE - this will slow down each subscribe call a bit, especially for lat/lng pairs in sparsely populated areas. Currently our automated background processes can and will overwrite this based on opens and clicks.
string MC_LANGUAGE Set the member&#039;s language preference. Supported codes are fully case-sensitive and can be found &lt;a href=&quot;http://kb.mailchimp.com/article/can-i-see-what-languages-my-subscribers-use#code&quot; target=&quot;_new&quot;&gt;here&lt;/a&gt;.
array MC_NOTES Add, update, or delete notes associated with a member. The array must contain either a &quot;note&quot; key (the note to set) or an &quot;id&quot; key (the note id to modify). If the &quot;id&quot; key exists and is valid, an &quot;update&quot; key may be set to &quot;append&quot; (default), &quot;prepend&quot;, &quot;replace&quot;, or &quot;delete&quot; to handle how we should update existing notes. If a &quot;note&quot; key is passed and the &quot;id&quot; key is not passed or is not valid, a new note will be added. &quot;delete&quot;, obviously, will only work with a valid &quot;id&quot; - passing that along with &quot;note&quot; and an invalid &quot;id&quot; is wrong and will be ignored. If this is not an array, it will silently be ignored.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Handling Field Data Types&lt;/strong&gt; - most fields you can just pass a string and all is well. For some, though, that is not the case...
Field values should be formatted as follows:
string address For the string version of an Address, the fields should be delimited by &lt;strong&gt;2&lt;/strong&gt; spaces. Address 2 can be skipped. The Country should be a 2 character ISO-3166-1 code and will default to your default country if not set
array address For the array version of an Address, the requirements for Address 2 and Country are the same as with the string version. Then simply pass us an array with the keys &lt;strong&gt;addr1&lt;/strong&gt;, &lt;strong&gt;addr2&lt;/strong&gt;, &lt;strong&gt;city&lt;/strong&gt;, &lt;strong&gt;state&lt;/strong&gt;, &lt;strong&gt;zip&lt;/strong&gt;, &lt;strong&gt;country&lt;/strong&gt; and appropriate values for each&lt;/p&gt;
&lt;p&gt;string birthday the month and day of birth, passed as MM/DD
array birthday the month and day of birth, passed in an array using the keys &lt;strong&gt;month&lt;/strong&gt; and &lt;strong&gt;day&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;string date use YYYY-MM-DD to be safe. Generally, though, anything strtotime() understands we&#039;ll understand - &lt;a href=&quot;http://us2.php.net/strtotime&quot; target=&quot;_blank&quot;&gt;&lt;a href=&quot;http://us2.php.net/strtotime&quot;&gt;http://us2.php.net/strtotime&lt;/a&gt;&lt;/a&gt;
string dropdown can be a normal string - we &lt;em&gt;will&lt;/em&gt; validate that the value is a valid option
string image must be a valid, existing url. we &lt;em&gt;will&lt;/em&gt; check its existence
string multi_choice can be a normal string - we &lt;em&gt;will&lt;/em&gt; validate that the value is a valid option
double number pass in a valid number - anything else will turn in to zero (0). Note, this will be rounded to 2 decimal places
string phone If your account has the US Phone numbers option set, this &lt;em&gt;must&lt;/em&gt; be in the form of NPA-NXX-LINE (404-555-1212). If not, we assume an International number and will simply set the field with what ever number is passed in.
string website This is a standard string, but we &lt;em&gt;will&lt;/em&gt; verify that it looks like a valid URL
string zip A U.S. zip code. We&#039;ll validate this is a 4 or 5 digit number.&lt;/p&gt;
* $email_type **string** - &lt;p&gt;optional email type preference for the email (html or text - defaults to html)&lt;/p&gt;
* $double_optin **boolean** - &lt;p&gt;optional flag to control whether a double opt-in confirmation message is sent, defaults to true. &lt;em&gt;Abusing this may cause your account to be suspended.&lt;/em&gt;&lt;/p&gt;
* $update_existing **boolean** - &lt;p&gt;optional flag to control whether existing subscribers should be updated instead of throwing an error, defaults to false&lt;/p&gt;
* $replace_interests **boolean** - &lt;p&gt;optional flag to determine whether we replace the interest groups with the groups provided or we add the provided groups to the member&#039;s interest groups (optional, defaults to true)&lt;/p&gt;
* $send_welcome **boolean** - &lt;p&gt;optional if your double_optin is false and this is true, we will send your lists Welcome Email if this subscribe succeeds - this will &lt;em&gt;not&lt;/em&gt; fire if we end up updating an existing subscriber. If double_optin is true, this has no effect. defaults to false.&lt;/p&gt;


### listUnsubscribe

    boolean MCAPI::listUnsubscribe(string $id, string $email_address, boolean $delete_member, boolean $send_goodbye, boolean $send_notify)

Unsubscribe the given email address from the list


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $email_address **string** - &lt;p&gt;the email address to unsubscribe  OR the email &quot;id&quot; returned from listMemberInfo, Webhooks, and Campaigns&lt;/p&gt;
* $delete_member **boolean** - &lt;p&gt;flag to completely delete the member from your list instead of just unsubscribing, default to false&lt;/p&gt;
* $send_goodbye **boolean** - &lt;p&gt;flag to send the goodbye email to the email address, defaults to true&lt;/p&gt;
* $send_notify **boolean** - &lt;p&gt;flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to true&lt;/p&gt;


### listUpdateMember

    boolean MCAPI::listUpdateMember(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. If you are doing a batch update on lots of users,
consider using listBatchSubscribe() with the update_existing and possible replace_interests parameter.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $email_address **string** - &lt;p&gt;the current email address of the member to update OR the &quot;id&quot; for the member returned from listMemberInfo, Webhooks, and Campaigns&lt;/p&gt;
* $merge_vars **array** - &lt;p&gt;array of new field values to update the member with.  See merge_vars in listSubscribe() for details.&lt;/p&gt;
* $email_type **string** - &lt;p&gt;change the email type preference for the member (&quot;html&quot; or &quot;text&quot;).  Leave blank to keep the existing preference (optional)&lt;/p&gt;
* $replace_interests **boolean** - &lt;p&gt;flag to determine whether we replace the interest groups with the updated groups provided, or we add the provided groups to the member&#039;s interest groups (optional, defaults to true)&lt;/p&gt;


### listBatchSubscribe

    array MCAPI::listBatchSubscribe(string $id, array $batch, boolean $double_optin, boolean $update_existing, boolean $replace_interests)

Subscribe a batch of email addresses to a list at once. If you are using a serialized version of the API, we strongly suggest that you
only run this method as a POST request, and <em>not</em> a GET request. Maximum batch sizes vary based on the amount of data in each record,
though you should cap them at 5k - 10k records, depending on your experience. These calls are also long, so be sure you increase your timeout values.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $batch **array** - &lt;p&gt;an array of structs for each address to import with two special keys: &quot;EMAIL&quot; for the email address, and &quot;EMAIL_TYPE&quot; for the email type option (html or text). Aside from those, see listSubscribe() for other merge var options&lt;/p&gt;
* $double_optin **boolean** - &lt;p&gt;flag to control whether to send an opt-in confirmation email - defaults to true&lt;/p&gt;
* $update_existing **boolean** - &lt;p&gt;flag to control whether to update members that are already subscribed to the list or to return an error, defaults to false (return error)&lt;/p&gt;
* $replace_interests **boolean** - &lt;p&gt;flag to determine whether we replace the interest groups with the updated groups provided, or we add the provided groups to the member&#039;s interest groups (optional, defaults to true)&lt;/p&gt;


### listBatchUnsubscribe

    array MCAPI::listBatchUnsubscribe(string $id, array $emails, boolean $delete_member, boolean $send_goodbye, boolean $send_notify)

Unsubscribe a batch of email addresses to a list


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $emails **array** - &lt;p&gt;array of email addresses to unsubscribe&lt;/p&gt;
* $delete_member **boolean** - &lt;p&gt;flag to completely delete the member from your list instead of just unsubscribing, default to false&lt;/p&gt;
* $send_goodbye **boolean** - &lt;p&gt;flag to send the goodbye email to the email addresses, defaults to true&lt;/p&gt;
* $send_notify **boolean** - &lt;p&gt;flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to false&lt;/p&gt;


### listMembers

    array MCAPI::listMembers(string $id, string $status, string $since, integer $start, integer $limit, string $sort_dir)

Get all of the list members for a list that are of a particular status. Are you trying to get a dump including lots of merge
data or specific members of a list? If so, checkout the <a href="/export">Export API</a>


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $status **string** - &lt;p&gt;the status to get members for - one of(subscribed, unsubscribed, &lt;a target=&quot;_blank&quot; href=&quot;http://eepurl.com/gWOO&quot;&gt;cleaned&lt;/a&gt;, updated), defaults to subscribed&lt;/p&gt;
* $since **string** - &lt;p&gt;optional pull all members whose status (subscribed/unsubscribed/cleaned) has changed or whose profile (updated) has changed since this date/time - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 100, upper limit set at 15000&lt;/p&gt;
* $sort_dir **string** - &lt;p&gt;optional ASC for ascending, DESC for descending. defaults to ASC even if an invalid value is encountered.&lt;/p&gt;


### listMemberInfo

    array MCAPI::listMemberInfo(string $id, array $email_address)

Get all the information for particular members of a list


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $email_address **array** - &lt;p&gt;an array of up to 50 email addresses to get information for OR the &quot;id&quot;(s) for the member returned from listMembers, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC).&lt;/p&gt;


### listMemberActivity

    array MCAPI::listMemberActivity(string $id, array $email_address)

Get the most recent 100 activities for particular list members (open, click, bounce, unsub, abuse, sent to)


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $email_address **array** - &lt;p&gt;an array of up to 50 email addresses to get information for OR the &quot;id&quot;(s) for the member returned from listMembers, Webhooks, and Campaigns.&lt;/p&gt;


### listAbuseReports

    array MCAPI::listAbuseReports(string $id, integer $start, integer $limit, string $since)

Get all email addresses that complained about a given campaign


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to pull abuse reports for (can be gathered using lists())&lt;/p&gt;
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 500, upper limit set at 1000&lt;/p&gt;
* $since **string** - &lt;p&gt;optional pull only messages since this time - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;&lt;/p&gt;


### listGrowthHistory

    array MCAPI::listGrowthHistory(string $id)

Access the Growth History by Month for a given list.


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;


### listActivity

    array MCAPI::listActivity(string $id)

Access up to the previous 180 days of daily detailed aggregated activity stats for a given list


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;


### listLocations

    array MCAPI::listLocations(string $id)

Retrieve the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;


### listClients

    array MCAPI::listClients(string $id)

Retrieve the clients that the list's subscribers have been tagged as being used based on user agents seen. Made possible by <a href="http://user-agent-string.info" target="_blank">user-agent-string.info</a>


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;


### templates

    array MCAPI::templates(array $types, string $category, array $inactives)

Retrieve various templates available in the system, allowing some thing similar to our template gallery to be created.


* Visibility: **public**


#### Arguments
* $types **array** - &lt;p&gt;optional the types of templates to return
boolean user    Custom templates for this user account. Defaults to true.
boolean gallery Templates from our Gallery. Note that some templates that require extra configuration are withheld. (eg, the Etsy template). Defaults to false.
boolean base    Our &quot;start from scratch&quot; extremely basic templates. Defaults to false.&lt;/p&gt;
* $category **string** - &lt;p&gt;optional for Gallery templates only, limit to a specific template category&lt;/p&gt;
* $inactives **array** - &lt;p&gt;optional options to control how inactive templates are returned, if at all
boolean include user templates are not deleted, only set inactive. defaults to false.
boolean only    only include inactive templates. defaults to false.&lt;/p&gt;


### templateInfo

    array MCAPI::templateInfo(integer $tid, string $type)

Pull details for a specific template to help support editing


* Visibility: **public**


#### Arguments
* $tid **integer** - &lt;p&gt;the template id - get from templates()&lt;/p&gt;
* $type **string** - &lt;p&gt;optional the template type to load - one of &#039;user&#039;, &#039;gallery&#039;, &#039;base&#039;, defaults to user.&lt;/p&gt;


### templateAdd

    integer MCAPI::templateAdd(string $name, string $html)

Create a new user template, <strong>NOT</strong> campaign content. These templates can then be applied while creating campaigns.


* Visibility: **public**


#### Arguments
* $name **string** - &lt;p&gt;the name for the template - names must be unique and a max of 50 bytes&lt;/p&gt;
* $html **string** - &lt;p&gt;a string specifying the entire template to be created. This is &lt;strong&gt;NOT&lt;/strong&gt; campaign content. They are intended to utilize our &lt;a href=&quot;http://www.mailchimp.com/resources/email-template-language/&quot; target=&quot;_blank&quot;&gt;template language&lt;/a&gt;.&lt;/p&gt;


### templateUpdate

    boolean MCAPI::templateUpdate(integer $id, array $values)

Replace the content of a user template, <strong>NOT</strong> campaign content.


* Visibility: **public**


#### Arguments
* $id **integer** - &lt;p&gt;the id of the user template to update&lt;/p&gt;
* $values **array** - &lt;p&gt;the values to updates - while both are optional, at least one should be provided. Both can be updated at the same time.
string name optional the name for the template - names must be unique and a max of 50 bytes
string html optional a string specifying the entire template to be created. This is &lt;strong&gt;NOT&lt;/strong&gt; campaign content. They are intended to utilize our &lt;a href=&quot;http://www.mailchimp.com/resources/email-template-language/&quot; target=&quot;_blank&quot;&gt;template language&lt;/a&gt;.&lt;/p&gt;


### templateDel

    boolean MCAPI::templateDel(integer $id)

Delete (deactivate) a user template


* Visibility: **public**


#### Arguments
* $id **integer** - &lt;p&gt;the id of the user template to delete&lt;/p&gt;


### templateUndel

    boolean MCAPI::templateUndel(integer $id)

Undelete (reactivate) a user template


* Visibility: **public**


#### Arguments
* $id **integer** - &lt;p&gt;the id of the user template to reactivate&lt;/p&gt;


### getAccountDetails

    array MCAPI::getAccountDetails(array $exclude)

Retrieve lots of account information including payments made, plan info, some account stats, installed modules,
contact info, and more. No private information like Credit Card numbers is available.


* Visibility: **public**


#### Arguments
* $exclude **array** - &lt;p&gt;optional defaults to nothing for backwards compatibility. Allows controlling which extra arrays are returned since they can slow down calls. Valid keys are &quot;modules&quot;, &quot;orders&quot;, &quot;rewards-credits&quot;, &quot;rewards-inspections&quot;, &quot;rewards-referrals&quot;, and &quot;rewards-applied&quot;. Hint: &quot;rewards-referrals&quot; is typically the culprit. To avoid confusion, if data is excluded, the corresponding key &lt;strong&gt;will not be returned at all&lt;/strong&gt;.&lt;/p&gt;


### getVerifiedDomains

    array MCAPI::getVerifiedDomains()

Retrieve all domains verification records for an account


* Visibility: **public**


### generateText

    string MCAPI::generateText(string $type, mixed $content)

Have HTML content auto-converted to a text-only format. You can send: plain HTML, an array of Template content, an existing Campaign Id, or an existing Template Id. Note that this will <strong>not</strong> save anything to or update any of your lists, campaigns, or templates.


* Visibility: **public**


#### Arguments
* $type **string** - &lt;p&gt;The type of content to parse. Must be one of: &quot;html&quot;, &quot;template&quot;, &quot;url&quot;, &quot;cid&quot; (Campaign Id), or &quot;tid&quot; (Template Id)&lt;/p&gt;
* $content **mixed** - &lt;p&gt;The content to use. For &quot;html&quot; expects  a single string value, &quot;template&quot; expects an array like you send to campaignCreate, &quot;url&quot; expects a valid &amp; public URL to pull from, &quot;cid&quot; expects a valid Campaign Id, and &quot;tid&quot; expects a valid Template Id on your account.&lt;/p&gt;


### inlineCss

    string MCAPI::inlineCss(string $html, boolean $strip_css)

Send your HTML content to have the CSS inlined and optionally remove the original styles.


* Visibility: **public**


#### Arguments
* $html **string** - &lt;p&gt;Your HTML content&lt;/p&gt;
* $strip_css **boolean** - &lt;p&gt;optional Whether you want the CSS &amp;lt;
style&amp;gt;
tags stripped from the returned document. Defaults to false.&lt;/p&gt;


### folders

    array MCAPI::folders(string $type)

List all the folders for a user account


* Visibility: **public**


#### Arguments
* $type **string** - &lt;p&gt;optional the type of folders to return - either &quot;campaign&quot; or &quot;autoresponder&quot;. Defaults to &quot;campaign&quot;&lt;/p&gt;


### folderAdd

    integer MCAPI::folderAdd(string $name, string $type)

Add a new folder to file campaigns or autoresponders in


* Visibility: **public**


#### Arguments
* $name **string** - &lt;p&gt;a unique name for a folder (max 100 bytes)&lt;/p&gt;
* $type **string** - &lt;p&gt;optional the type of folder to create - either &quot;campaign&quot; or &quot;autoresponder&quot;. Defaults to &quot;campaign&quot;&lt;/p&gt;


### folderUpdate

    boolean MCAPI::folderUpdate(integer $fid, string $name, string $type)

Update the name of a folder for campaigns or autoresponders


* Visibility: **public**


#### Arguments
* $fid **integer** - &lt;p&gt;the folder id to update - retrieve from folders()&lt;/p&gt;
* $name **string** - &lt;p&gt;a new, unique name for the folder (max 100 bytes)&lt;/p&gt;
* $type **string** - &lt;p&gt;optional the type of folder to create - either &quot;campaign&quot; or &quot;autoresponder&quot;. Defaults to &quot;campaign&quot;&lt;/p&gt;


### folderDel

    boolean MCAPI::folderDel(integer $fid, string $type)

Delete a campaign or autoresponder folder. Note that this will simply make campaigns in the folder appear unfiled, they are not removed.


* Visibility: **public**


#### Arguments
* $fid **integer** - &lt;p&gt;the folder id to update - retrieve from folders()&lt;/p&gt;
* $type **string** - &lt;p&gt;optional the type of folder to create - either &quot;campaign&quot; or &quot;autoresponder&quot;. Defaults to &quot;campaign&quot;&lt;/p&gt;


### ecommOrders

    array MCAPI::ecommOrders(integer $start, integer $limit, string $since)

Retrieve the Ecommerce Orders for an account


* Visibility: **public**


#### Arguments
* $start **integer** - &lt;p&gt;optional for large data sets, the page number to start at - defaults to 1st page of data  (page 0)&lt;/p&gt;
* $limit **integer** - &lt;p&gt;optional for large data sets, the number of results to return - defaults to 100, upper limit set at 500&lt;/p&gt;
* $since **string** - &lt;p&gt;optional pull only messages since this time - 24 hour format in &lt;strong&gt;GMT&lt;/strong&gt;, eg &quot;2013-12-30 20:30:00&quot;&lt;/p&gt;


### ecommOrderAdd

    boolean MCAPI::ecommOrderAdd(array $order)

Import Ecommerce Order Information to be used for Segmentation. This will generally be used by ecommerce package plugins
<a href="http://connect.mailchimp.com/category/ecommerce" target="_blank">provided by us or by 3rd part system developers</a>.


* Visibility: **public**


#### Arguments
* $order **array** - &lt;p&gt;an array of information pertaining to the order that has completed. Use the following keys:
string id the Order Id
string email_id optional (kind of) the Email Id of the subscriber we should attach this order to (see the &quot;mc_eid&quot; query string variable a campaign passes) - either this or &lt;strong&gt;email&lt;/strong&gt; is required. If both are provided, email_id takes precedence
string email optional (kind of) the Email Address we should attach this order to - either this or &lt;strong&gt;email_id&lt;/strong&gt; is required. If both are provided, email_id takes precedence
double total The Order Total (ie, the full amount the customer ends up paying)
string order_date optional the date of the order - if this is not provided, we will default the date to now
double shipping optional the total paid for Shipping Fees
double tax optional the total tax paid
string store_id a unique id for the store sending the order in (20 bytes max)
string store_name optional a &quot;nice&quot; name for the store - typically the base web address (ie, &quot;store.mailchimp.com&quot;). We will automatically update this if it changes (based on store_id)
string campaign_id optional the Campaign Id to track this order with (see the &quot;mc_cid&quot; query string variable a campaign passes)
array items the individual line items for an order using these keys:&lt;/p&gt;
&lt;div style=&quot;padding-left:30px&quot;&gt;&lt;table&gt;
int line_num optional the line number of the item on the order. We will generate these if they are not passed
int product_id the store&#039;s internal Id for the product. Lines that do no contain this will be skipped
string sku optional the store&#039;s internal SKU for the product. (max 30 bytes)
string product_name the product name for the product_id associated with this item. We will auto update these as they change (based on product_id)
int category_id the store&#039;s internal Id for the (main) category associated with this product. Our testing has found this to be a &quot;best guess&quot; scenario
string category_name the category name for the category_id this product is in. Our testing has found this to be a &quot;best guess&quot; scenario. Our plugins walk the category heirarchy up and send &quot;Root - SubCat1 - SubCat4&quot;, etc.
double qty optional the quantity of the item ordered - defaults to 1
double cost optional the cost of a single item (ie, not the extended cost of the line) - defaults to 0
&lt;/table&gt;&lt;/div&gt;


### ecommOrderDel

    boolean MCAPI::ecommOrderDel(string $store_id, string $order_id)

Delete Ecommerce Order Information used for segmentation. This will generally be used by ecommerce package plugins
<a href="/plugins/ecomm360.phtml">that we provide</a> or by 3rd part system developers.


* Visibility: **public**


#### Arguments
* $store_id **string** - &lt;p&gt;the store id the order belongs to&lt;/p&gt;
* $order_id **string** - &lt;p&gt;the order id (generated by the store) to delete&lt;/p&gt;


### listsForEmail

    array MCAPI::listsForEmail(string $email_address)

Retrieve all List Ids a member is subscribed to.


* Visibility: **public**


#### Arguments
* $email_address **string** - &lt;p&gt;the email address to check OR the email &quot;id&quot; returned from listMemberInfo, Webhooks, and Campaigns&lt;/p&gt;


### campaignsForEmail

    array MCAPI::campaignsForEmail(string $email_address, array $options)

Retrieve all Campaigns Ids a member was sent


* Visibility: **public**


#### Arguments
* $email_address **string** - &lt;p&gt;the email address to unsubscribe  OR the email &quot;id&quot; returned from listMemberInfo, Webhooks, and Campaigns&lt;/p&gt;
* $options **array** - &lt;p&gt;optional extra options to modify the returned data.
string list_id optional A list_id to limit the campaigns to
bool   verbose optional Whether or not to return verbose data (beta - this will change the return format into something undocumented, but consistent). defaults to false&lt;/p&gt;


### chimpChatter

    array MCAPI::chimpChatter()

Return the current Chimp Chatter messages for an account.


* Visibility: **public**


### searchMembers

    array MCAPI::searchMembers(string $query, string $id, $offset)

Search account wide or on a specific list using the specified query terms


* Visibility: **public**


#### Arguments
* $query **string** - &lt;p&gt;terms to search on, &lt;a href=&quot;http://kb.mailchimp.com/article/i-cant-find-a-recipient-on-my-list&quot; target=&quot;_blank&quot;&gt;just like you do in the app&lt;/a&gt;&lt;/p&gt;
* $id **string** - &lt;p&gt;optional the list id to limit the search to. Get by calling lists()&lt;/p&gt;
* $offset **mixed**


### searchCampaigns

    array MCAPI::searchCampaigns(string $query, $offset, $snip_start, $snip_end)

Search all campaigns for the specified query terms


* Visibility: **public**


#### Arguments
* $query **string** - &lt;p&gt;terms to search on&lt;/p&gt;
* $offset **mixed**
* $snip_start **mixed**
* $snip_end **mixed**


### apikeys

    array MCAPI::apikeys(string $username, string $password, boolean $expired)

Retrieve a list of all MailChimp API Keys for this User


* Visibility: **public**


#### Arguments
* $username **string** - &lt;p&gt;Your MailChimp user name&lt;/p&gt;
* $password **string** - &lt;p&gt;Your MailChimp password&lt;/p&gt;
* $expired **boolean** - &lt;p&gt;optional - whether or not to include expired keys, defaults to false&lt;/p&gt;


### apikeyAdd

    string MCAPI::apikeyAdd(string $username, string $password)

Add an API Key to your account. We will generate a new key for you and return it.


* Visibility: **public**


#### Arguments
* $username **string** - &lt;p&gt;Your MailChimp user name&lt;/p&gt;
* $password **string** - &lt;p&gt;Your MailChimp password&lt;/p&gt;


### apikeyExpire

    boolean MCAPI::apikeyExpire(string $username, string $password)

Expire a Specific API Key. Note that if you expire all of your keys, just visit <a href="http://admin.mailchimp.com/account/api" target="_blank">your API dashboard</a>
to create a new one. If you are trying to shut off access to your account for an old developer, change your
MailChimp password, then expire all of the keys they had access to. Note that this takes effect immediately, so make
sure you replace the keys in any working application before expiring them! Consider yourself warned.

..

* Visibility: **public**


#### Arguments
* $username **string** - &lt;p&gt;Your MailChimp user name&lt;/p&gt;
* $password **string** - &lt;p&gt;Your MailChimp password&lt;/p&gt;


### ping

    string MCAPI::ping()

"Ping" the MailChimp API - a simple method you can call that will return a constant value as long as everything is good. Note
than unlike most all of our methods, we don't throw an Exception if we are having issues. You will simply receive a different
string back that will explain our view on what is going on.


* Visibility: **public**


### deviceRegister

    array MCAPI::deviceRegister(string $mobile_key, array $details)

Register a mobile device


* Visibility: **public**


#### Arguments
* $mobile_key **string** - &lt;p&gt;a valid key identifying your mobile application.&lt;/p&gt;
* $details **array** - &lt;p&gt;the details for the device registration&lt;/p&gt;


### deviceUnregister

    array MCAPI::deviceUnregister(string $mobile_key, string $device_id)

Unregister a mobile device


* Visibility: **public**


#### Arguments
* $mobile_key **string** - &lt;p&gt;a valid key identifying your mobile application.&lt;/p&gt;
* $device_id **string** - &lt;p&gt;the device id used for the device registration&lt;/p&gt;


### gmonkeyAdd

    array MCAPI::gmonkeyAdd(string $id, array $email_address)

Add Golden Monkey(s)


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $email_address **array** - &lt;p&gt;an array of email addresses (max 50) to attempt to flag as Golden Monkeys&lt;/p&gt;


### gmonkeyDel

    array MCAPI::gmonkeyDel(string $id, array $email_address)

Remove Golden Monkey(s)


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the list id to connect to. Get by calling lists()&lt;/p&gt;
* $email_address **array** - &lt;p&gt;an array of email addresses (max 50) to attempt to remove Golden Monkey status from.&lt;/p&gt;


### gmonkeyMembers

    array MCAPI::gmonkeyMembers()

Retrieve all Golden Monkey(s) for an account


* Visibility: **public**


### gmonkeyActivity

    array MCAPI::gmonkeyActivity()

Retrieve all Activity (opens/clicks) for Golden Monkeys over the past 10 days


* Visibility: **public**


### callMethod

    mixed MCAPI::callMethod()

Internal function - proxy method for certain XML-RPC calls | DO NOT CALL


* Visibility: **public**


### callServer

    mixed MCAPI::callServer($method, $params)

Actually connect to the server and call the requested methods, parsing the result
You should never have to call this function manually


* Visibility: **public**


#### Arguments
* $method **mixed**
* $params **mixed**