API and documentation

Parameters

Note: You can also pass values into custom fields. To add values to your desired custom field, use the personalization tag of the custom field as the parameter. Say, your custom field tag is [Birthday,fallback=], you can use the parameter, 'Birthday' to add values to this custom field.

1.    name user's name is optional
2.    email user's email
3.    list the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID
4.    boolean set this to "true" so that you'll get a plain text response

Response

•    Success: true
•    Error: Some fields are missing.
•    Error: Invalid email address.
•    Error: Invalid list ID.
•    Error: Already subscribed.

This method unsubscribes a user from a list.

Parameters

1.    email user's email
2.    list the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID
3.    boolean set this to "true" so that you'll get a plain text response

Response

•    Success: true
•    Error: Some fields are missing.
•    Error: Invalid email address.

This method gets the current status of a subscriber (eg. subscribed, unsubscribed, bounced, complained).

Parameters

1.    api_key your API key, available in Settings.
2.    email user's email
3.    list the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID

Response

•    Success: Subscribed
•    Success: Unsubscribed
•    Success: Unconfirmed
•    Success: Bounced
•    Success: Soft bounced
•    Success: Complained
•    Error: No data passed
•    Error: API key not passed
•    Error: Invalid API key
•    Error: Email not passed
•    Error: List ID not passed
•    Error: Email does not exist in list

This method gets the total active subscriber count.

Parameters

1.    api_key your API key, available in Settings.
2.    list_id the id of the list you want to get the active subscriber count. This encrypted id can be found under View all lists section named ID

Response

•    Success: You'll get an integer of the active subscriber count
•    Error: No data passed
•    Error: API key not passed
•    Error: Invalid API key
•    Error: List ID not passed
•    Error: List does not exist

This method creates a campaign (with an option to send it too).

Parameters

1.    api_key your API key, available in Settings.
2.    from_name the 'From name' of your campaign
3.    from_email the 'From email' of your campaign
4.    reply_to the 'Reply to' of your campaign
5.    subject the 'Subject' of your campaign
6.    plain_text the 'Plain text version' of your campaign (optional)
7.    html_text the 'HTML version' of your campaign
8.    list_ids Required only if you set send_campaign to 1 to send the campaign and not just create a draft. List IDs should be single or comma-separated. The encrypted & hashed ids can be found under View all lists section named ID.
9.    brand_id Required only if you are creating a 'Draft' campaign (send_campaign set to 0 or left as default). Brand IDs can be found under 'Brands' page named ID
10.    query_string eg. Google Analytics tags
11.    send_campaign Set to 1 if you want to send the campaign as well and not just create a draft. Default is 0.

Response

•    Success: Campaign created
•    Success: Campaign created and now sending
•    Error: No data passed
•    Error: API key not passed
•    Error: Invalid API key
•    Error: From name not passed
•    Error: From email not passed
•    Error: Reply to email not passed
•    Error: Subject not passed
•    Error: HTML not passed
•    Error: List ID(s) not passed
•    Error: One or more list IDs are invalid
•    Error: List IDs does not belong to a single brand
•    Error: Brand ID not passed
•    Error: Unable to create campaign
•    Error: Unable to create and send campaign