API

{{#if accessToken}} Personal access token: {{accessToken}} {{else}} Access token not yet generated {{/if}}

Notes about the API

API response is a JSON structure with error and data properties. If the response error has a value set then the request failed.
You need to define proper Content-Type when making a request. You can either use application/x-www-form-urlencoded for normal form data or application/json for a JSON payload. Using multipart/form-data is not supported.

POST /api/subscribe/:listId – Add subscription

This API call either inserts a new subscription or updates existing. Fields not included are left as is, so if you update only LAST_NAME value, then FIRST_NAME is kept untouched for an existing subscription.

GET arguments

access_token – your personal access token

POST arguments

EMAIL – subscriber's email address (required)
FIRST_NAME – subscriber's first name
LAST_NAME – subscriber's last name
TIMEZONE – subscriber's timezone (eg. "Europe/Tallinn", "PST" or "UTC"). If not set defaults to "UTC"
MERGE_TAG_VALUE – custom field value. Use yes/no for option group values (checkboxes, radios, drop downs)

Additional POST arguments:

FORCE_SUBSCRIBE – set to "yes" if you want to make sure the email is marked as subscribed even if it was previously marked as unsubscribed. If the email was already unsubscribed/blocked then subscription status is not changed by default.
REQUIRE_CONFIRMATION – set to "yes" if you want to send confirmation email to the subscriber before actually marking as subscribed

Example

curl -XPOST {{serviceUrl}}api/subscribe/B16uVTdW?access_token={{accessToken}} \
--data 'EMAIL=test@example.com&MERGE_CHECKBOX=yes&REQUIRE_CONFIRMATION=yes'

POST /api/unsubscribe/:listId – Remove subscription

This API call marks a subscription as unsubscribed

GET arguments

access_token – your personal access token

POST arguments

EMAIL – subscriber's email address (required)

Example

curl -XPOST {{serviceUrl}}api/unsubscribe/B16uVTdW?access_token={{accessToken}} \
--data 'EMAIL=test@example.com'

POST /api/delete/:listId – Delete subscription

This API call deletes a subscription

GET arguments

access_token – your personal access token

POST arguments

EMAIL – subscriber's email address (required)

Example

curl -XPOST {{serviceUrl}}api/delete/B16uVTdW?access_token={{accessToken}} \
--data 'EMAIL=test@example.com'

POST /api/field/:listId – Add new custom field

This API call creates a new custom field for a list.

GET arguments

access_token – your personal access token

POST arguments

NAME – field name (required)
TYPE – one of the following types:
- {{type}} {{description}}
GROUP – If the type is 'option' then you also need to specify the parent element ID
GROUP_TEMPLATE – Template for the group element. If not set, then values of the elements are joined with commas
VISIBLE – yes/no, if not visible then the subscriber can not view or modify this value at the profile page

Example

curl -XPOST {{serviceUrl}}api/field/B16uVTdW?access_token={{accessToken}} \
--data 'NAME=Birthday&TYPE=birthday-us&VISIBLE=yes'