Add subscriber to list

Subscribe an email address to one of your lists.

Endpoint

POST /lists/:uuid/subscribers


Required parameters

api_token string
Your api_token.

uuid string
Your list UUID.

email string
Your subscriber's email.

hosting_url string
We use this url to create the referral link your users will share. This is usually the url of the page where you have installed Maître.

Optional parameters

name string
Your subscriber's name.

extra_field string
Extra information. Eg: phone number or zip code.

test_mode boolean
If set to true, the response will contain fake data and neither views nor registrations will be saved. Use this feature to test your integration before you go live without inflating your analytics.

referral string
The referrer's code. We use this code to attribute the referral to the subscriber with that specific referral code. This is where the magic happens.

points integer
Number of initial points you assign to the subscriber. It can't be less than 1. By default is 1.

referral_points integer
Number of points you assign to the subscriber's referrer. If the subscriber has been referred by someone you can give this person an arbitrary number of points. It can't be less than 1. By default is 1.

double_optin boolean
If set to false the subscriber will not receive a confirmation email. By default is true. If you decide to disable the double opt-in it will be your responsibility to demonstrate you have the permission to add this subscriber to your list.

source string
Source of the visit. Use it to attribute the visit and the conversion to a specific marketing channel (eg: facebook-ads). Maître will automatically create beautiful reports about visits and conversions for each source in your Analytics page.

device string
Subscriber's Device. Use it to attribute the visit and the conversion to a specific device. Possible values are:   mobiletablet and desktop. Maître will automatically create beautiful reports about visits and conversions for each device in your Analytics page.


Example response

{
  "status": "ok",
  "data": {
    "response": "subscriber_created",
    < Subscriber object >
  },
  "calls_left": 1000,
  "timestamp": 1487661494
}

Subscriber object

Still need help? Contact Us Contact Us