{{#translate}}API{{/translate}}

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

{{#translate}}Notes about the API{{/translate}}

{{#translate}}API response is a JSON structure with error and data properties. If the response error has a value set then the request failed.{{/translate}}
{{#translate}}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.{{/translate}}

GET /api/subscriptions/:listId – {{#translate}}Get list of subscriptions{{/translate}}

{{#translate}}Retrieve a list of subscriptions to the list referenced by :listId. All fields of the subscribers will be returned. Note that custom fields will have generated names.{{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}
start – {{#translate}}Start position{{/translate}} ({{#translate}}optional, default 0{{/translate}})
limit – {{#translate}}limit subscription count in response{{/translate}} ({{#translate}}optional, default 10000{{/translate}})

{{#translate}}Example{{/translate}}

curl -XGET '{{serviceUrl}}api/subscriptions/B16uVTdW?access_token={{accessToken}}&limit=10&start=0'

POST /api/subscribe/:listId – {{#translate}}Add subscription{{/translate}}

{{#translate}}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.{{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

POST {{#translate}}arguments{{/translate}}

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

{{#translate}}Additional POST arguments{{/translate}}:

FORCE_SUBSCRIBE – {{#translate}}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{{/translate}} by default.
REQUIRE_CONFIRMATION – {{#translate}}set to "yes" if you want to send confirmation email to the subscriber before actually marking as subscribed{{/translate}}

{{#translate}}Example{{/translate}}

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

POST /api/unsubscribe/:listId – {{#translate}}Remove subscription{{/translate}}

{{#translate}}This API call marks a subscription as unsubscribed{{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

POST {{#translate}}arguments{{/translate}}

EMAIL – {{#translate}}subscriber's email address{{/translate}} ({{#translate}}required{{/translate}})

{{#translate}}Example{{/translate}}

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

POST /api/delete/:listId – {{#translate}}Delete subscription{{/translate}}

{{#translate}}This API call deletes a subscription{{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

POST {{#translate}}arguments{{/translate}}

EMAIL – {{#translate}}subscriber's email address{{/translate}} ({{#translate}}required{{/translate}})

{{#translate}}Example{{/translate}}

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

POST /api/field/:listId – {{#translate}}Add new custom field{{/translate}}

{{#translate}}This API call creates a new custom field for a list.{{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

POST {{#translate}}arguments{{/translate}}

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

{{#translate}}Example{{/translate}}

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

GET /api/blacklist/get – {{#translate}}Get list of blacklisted emails{{/translate}}

{{#translate}}This API call get list of blacklisted emails.{{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}
start – {{#translate}}Start position{{/translate}} ({{#translate}}optional, default 0{{/translate}})
limit – {{#translate}}limit emails count in response{{/translate}} ({{#translate}}optional, default 10000{{/translate}})
search – {{#translate}}filter by part of email{{/translate}} ({{#translate}}optional, default ''{{/translate}})

{{#translate}}Example{{/translate}}

curl -XGET '{{serviceUrl}}api/blacklist/get?access_token={{accessToken}}&limit=10&start=10&search=gmail'

POST /api/blacklist/add – {{#translate}}Add email to blacklist{{/translate}}

{{#translate}}This API call either add emails to blacklist{{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

POST {{#translate}}arguments{{/translate}}

EMAIL – {{#translate}}email address{{/translate}} ({{#translate}}required{{/translate}})

{{#translate}}Example{{/translate}}

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

POST /api/blacklist/delete – {{#translate}}Delete email from blacklist{{/translate}}

{{#translate}}This API call either delete emails from blacklist{{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

POST {{#translate}}arguments{{/translate}}

EMAIL – {{#translate}}email address{{/translate}} ({{#translate}}required{{/translate}})

{{#translate}}Example{{/translate}}

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

GET /api/lists/:email – {{#translate}}Get the lists a user has subscribed to{{/translate}}

{{#translate}}Retrieve the lists that the user with :email has subscribed to. {{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

{{#translate}}Example{{/translate}}

curl -XGET '{{serviceUrl}}api/lists/test@example.com?access_token={{accessToken}}

GET /api/lists – {{#translate}}Get all lists{{/translate}}

{{#translate}}Retrieve every list. {{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

{{#translate}}Example{{/translate}}

curl -XGET '{{serviceUrl}}api/lists?access_token={{accessToken}}'

GET /api/list/:id – {{#translate}}Get list by id{{/translate}}

{{#translate}}Retrieve the list with :id {{/translate}}

GET {{#translate}}arguments{{/translate}}

access_token – {{#translate}}your personal access token{{/translate}}

{{#translate}}Example{{/translate}}

curl -XGET '{{serviceUrl}}api/list/1?access_token={{accessToken}}'