API documentation

void addMergeTag ( string auth_token, integer list_id, string field_name, string field_type )

Adds a field to a list. (The request limit for this function is 10 requests each minute)

integer addSubscriber ( string auth_token, integer list_id, dict merge_fields, integer double_optin, integer update_subscriber, integer complete_json )

Adds a subscriber to a list.

list batchAddSubscribers ( string auth_token, integer list_id, integer update_subscriber, list subscribers_data, integer complete_json )

Adds a group of subscribers to a list. (The request limit for this function is 5 requests each second)

list batchDeleteSubscribers ( string auth_token, integer list_id, dict email_list )

Removes a group of subscribers from a list. (The request limit for this function is 10 requests each minute)

integer createList ( string auth_token, string sender_email, string name, string company, string country, string city, string address, string phone )

Creates a new subscribers list.

void deleteAllSubscribers ( string auth_token, integer list_id )

Removes all subscribers from a list. This function runs in the background, as it can take a few minutes depending on the size of the list. You can check when you've finished by calling the getListStats function and see that the value of total_subscribers is 0. (The request limit for this function is 10 requests each minute)

void deleteList ( string auth_token, integer list_id )

Deletes a list of subscribers. (The request limit for this function is 10 requests each minute)

void deleteSubscriber ( string auth_token, integer list_id, string email )

Removes a subscriber from a list.

integer getCreditsSMTP ( string auth_token )

Displays all the available SMTP credits from a client. (The request limit for this function is 10 requests each minute)

dict getFields ( string auth_token, integer list_id )

Displays the fields of the list and their type. (The request limit for this function is 10 requests each minute)

dict getForms ( string auth_token, integer list_id )

Displays forms associated to a list. (The request limit for this function is 5 requests each second)

list getInactiveSubscribers ( string auth_token, date date_from, date date_to, integer full_info )

Gets all subscribers who have become inactive (unsubscribed, complained or hard) between two dates. (The request limit for this function is 10 requests each minute)

dict getLists ( string auth_token )

Displays the available list of subscribers. (The request limit for this function is 5 requests each second)

dict getListFields ( string auth_token, integer list_id )

Displays all the information of the fields of a list such as the value, the type or the visibility, in JSON format.

list getListSegments ( string auth_token, integer list_id )

Displays the list of segments from a list.

dict getListStats ( string auth_token, integer list_id )

Displays general data about the list. (The request limit for this function is 10 requests each minute)

dict getListSubsStats ( string auth_token, integer list_id, integer block_index )

Gets data from the campaigns sent to each subscriber in the list. (The request limit for this function is 10 requests each minute)

dict getMergeFields ( string auth_token, integer list_id )

Displays the merge fields in the fields of the list and the type they have. (The request limit for this function is 10 requests each minute)

dict getSubscriberDetails ( string auth_token, integer list_id, string subscriber )

Displays advanced information about a subscriber. (The request limit for this function is 5 requests each second)

dict getSubscribers ( string auth_token, integer list_id, integer status, integer block_index, integer all_fields, integer complete_json )

Displays the list of subscribers from a list. (The request limit for this function is 10 requests each minute)

dict searchSubscriber ( string auth_token, string subscriber )

Returns the subscriber's advanced data in each list to which they belong. (The request limit for this function is 10 requests each minute)

void unsubscribeSubscriber ( string auth_token, integer list_id, email string )

Unsubscribes a subscriber from a list.