Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the id for the campaign to unschedule |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the id for the campaign to schedule |
| string | schedule_time | the time to schedule the campaign - in YYYY-MM-DD HH:II:SS format in GMT |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the id for the campaign to send |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the id for the campaign to test |
| array | test_emails | an array of email address to receive the test message |
| string | send_type | optional default (null) sends both, "html" or "text" send just that format |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | list_id | the list to send this campaign to- get lists using getLists() |
| 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 |
| array | content | the content for this campaign - use a struct with the following keys: "html" for pasted HTML content and "text" for the plain-text version. If you chose a template instead of pasting in your HTML content, then use "html_" followed by the template sections as keys - for example, use a key of "html_MAIN" to fill in the "MAIN" section of a template. Supported template sections include: "html_HEADER", "html_MAIN", "html_SIDECOLUMN", and "html_FOOTER" |
| integer | template_id | optional - use this template to generate the HTML content of the campaign |
| array | tracking | optional - set which recipient actions will be tracked, as a struct of boolean values with the following keys: "opens", "html_clicks", and "text_clicks". By default, opens and HTML clicks will be tracked. |
| 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 |
| string | analytics | optional - if provided, use a struct with "service type" as a key and the "service tag" as a value. For Google, this should be "google"=>"your_google_analytics_key_here". Note that only "google" is currently supported - a Google Analytics tags will be added to all links in the campaign with this string attached. Others may be added in the future |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | filter_id | optional - only show campaigns from this list id - get lists using getLists() |
| integer | filter_folder | optional - only show campaigns from this folder id - get folders using campaignFolders() |
| string | filter_fromname | optional - only show campaigns that have this "From Name" |
| string | filter_fromemail | optional - only show campaigns that have this "Reply-to Email" |
| string | filter_title | optional - only show campaigns that have this title |
| string | filter_subject | optional - only show campaigns that have this subject |
| string | filter_sendtimestart | optional - only show campaigns that have been sent since this date/time |
| string | filter_sendtimeend | optional - only show campaigns that have been sent before this date/time |
| boolean | filter_exact | optional - flag for whether to filter on exact values when filtering, or search within content for filter values |
| integer | start | optional - control paging of campaigns, start results at this campaign #, defaults to 1st page of data (page 0) |
| integer | limit | optional - control paging of campaigns, number of campaigns to return with each call, defaults to 25 (max=5000) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to pull stats for (can be gathered using campaigns($id)) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to pull stats for (can be gathered using campaigns($id)) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to pull bounces for (can be gathered using campaigns($id)) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to pull bounces for (can be gathered using campaigns($id)) |
| integer | start | art optional, for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| integer | limit | mit optional, for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000 |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to pull bounces for (can be gathered using campaigns($id)) |
| integer | start | art optional, for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| integer | limit | mit optional, for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000 |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to pull bounces for (can be gathered using campaigns($id)) |
| integer | start | art optional, for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| integer | limit | mit optional, for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000 |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to pull bounces for (can be gathered using campaigns($id)) |
| integer | start | art optional, for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| integer | limit | mit optional, for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000 |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to get content for (can be gathered using campaigns($id)) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to get opens for (can be gathered using campaigns($id)) |
| integer | start | art optional, for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| integer | limit | mit optional, for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000 |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to get no opens for (can be gathered using campaigns($id)) |
| integer | start | art optional, for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| integer | limit | mit optional, for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000 |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to get click stats for (can be gathered using campaigns($id)) |
| string | url | the URL of the link that was clicked on |
| integer | start | art optional, for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| integer | limit | mit optional, for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000 |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | cid | the campaign id to get stats for (can be gathered using campaigns($id)) |
| string | email_address | the email address to get activity history for |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
| string | email_address | the email address to subscribe |
| array | merge_vars | array of merges for the email (FNAME, LNAME, etc.) (see examples below for handling "blank" arrays). Set Interest Groups by passing a field named "INTERESTS" that contains a comma delimited list of Interest Groups to add. |
| string | email_type | optional - email type preference for the email (html or text, defaults to html) |
| boolean | double_optin | optional - flag to control whether a double opt-in confirmation message is sent, defaults to true |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
| string | email_address | the email address to unsubscribe |
| boolean | delete_member | flag to completely delete the member from your list instead of just unsubscribing, default to false |
| boolean | send_goodbye | flag to send the goodbye email to the email address, defaults to true |
| boolean | send_notify | flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to true |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
| string | email_address | the current email address of the member to update |
| array | merge_vars | array of new field values to update the member with. Use "EMAIL" to update the email address and "INTERESTS" to update the interest groups |
| string | email_type | change the email type preference for the member ("html" or "text"). Leave blank to keep the existing preference (optional) |
| boolean | replace_interests | flag to determine whether we replace the interest groups with the updated groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
| array | batch | an array of structs for each address to import with two special keys: "EMAIL" for the email address, and "EMAIL_TYPE" for the email type option (html or text) |
| boolean | double_optin | flag to control whether to send an opt-in confirmation email - defaults to true |
| boolean | update_existing | flag to control whether to update members that are already subscribed to the list or to return an error, defaults to false (return error) |
| boolean | replace_interests | flag to determine whether we replace the interest groups with the updated groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true) |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
| array | emails | array of email addresses to unsubscribe |
| boolean | delete_member | flag to completely delete the member from your list instead of just unsubscribing, default to false |
| boolean | send_goodbye | flag to send the goodbye email to the email addresses, defaults to true |
| boolean | send_notify | flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to false |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
| string | status | the status to get members for - one of(subscribed, unsubscribed, or cleaned), defaults to subscribed |
| integer | start | art optional, for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| integer | limit | mit optional, for large data sets, the number of results to return - defaults to 100, upper limit set at 15000 |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | uid | the id for your user account. Get by calling login($user, $pass) |
| string | id | the list id to connect to |
| string | email_address | the member email address to get information for |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | username | Your MailChimp user name |
| string | password | Your MailChimp password |
(return to index)
Description :
Parameters :
| Type | Name | Documentation |
| string | username | Your MailChimp user name |
| string | password | Your MailChimp password |
(return to index)
Description :
(return to index)