API и документация

Параметры

Примечание: Можно также передать значения в пользовательские поля. Для добавления значения к нужному полю, используйте тег персонализации пользовательского поля в качестве параметра. Скажем, ваш пользовательский тег поле [[Birthday,fallback=], вы можете использовать параметр, "Birthday", чтобы добавить значения этого пользовательского поля.

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

Ответ

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

Это метод отмены подписки пользователя из списка.

Параметры

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

Ответ

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

Этот метод получает текущий статус абонента (например. подписался, отписался, просмотрел, пожаловаться).

Параметры

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

Ответ

•    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

Этот метод получает общее количество активных подписчиков.

Параметры

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

Ответ

•    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

Этот метод создает кампанию (с возможностью отправки).

Параметры

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.

Ответ

•    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