Subscriber object

A subscriber is a person who is added to one of your lists.
Subscribers belong to precisely one list and can't be transferred.

Object fields

{
  "id": "sub_1564fabfe0bb",
  "name": "John Doe",
  "email": "john.doe@gmail.com",
  "extra_field": "+1 228374652",
  "code": "266-18bc5ad8",
  "position": null,
  "referred": false,
  "referred_by": {
    "id": "sub_42c5283fd538",
    "name": null,
    "email": "eee@ll.com",
    "code": "208-a4ff5779",
    "people_referred": 1,
    "points": 2
  },
  "people_referred": 0,
  "promoted": false,
  "promoted_at": null,
  "verified": true,
  "verified_at": 1491451155,
  "points": 1,
  "host": "https://maitreapp.co",
  "source": null,
  "device": null,
  "created_at": 1491451155,
  "last_updated_at": 1491451155
}

Fields

  • id - string
    Subscriber's unique identifier. IDs are globally unique and are used to retrieve or edit subscribers.
  • name - string
    Subscriber's name.
  • email - string
    Subscriber's email.
  • extra_field - string
    Subscriber's extra information. Eg: the phone number or zip code.
  • code - string
    Subscriber's referral code. Codes are globally unique and are used to generate referral links.
  • position - integer
    Subscriber's position in the queue. Available for waiting lists only.
  • referred - boolean
    True if the subscriber has been referred, false if not.
  • referred_by - hash
    If the subscriber has been referred, this field contains an hash with id, name, email, code, people_referred and points of the referral. Otherwise it's an empty hash. Also, if the referral has been deleted, the hash will be empty.
  • people_referred - integer
    Number of people referred by this subscriber.
  • promoted - boolean
    True is the subscriber is in the "promoted" list, false if not. Read more about the "promote list" here.
  • promoted_at - unix timestamp
    Unix timestamp (expressed in UTC) of when the subscriber has been promoted. If the subscriber has not been promoted the value is "null".
  • verified - boolean
    True if the subscriber has verified their email address, false if not. Also, the value will be true if the subscriber has been added with the "double_optin" value set to false. Read more about adding a subscriber here.
  • verified_at - unix timestamp
    Unix timestamp (expressed in UTC) of when the subscriber has verified their email address. If the subscriber is not verified the value is "null".
  • points - integer
    Subscriber's number of points.
  • host - string
    Url used to generate the referral link. Eg: if "host" is http://mywebsite.com and the "code" is 123ABC, then the referral link can be something like http://mywebsite.com?ref=123ABC or http://mywebsite.com?mwr=123ABC
  • source - string
    Where the user comes from. This is used mostly for analytics purposes (for example to see how many people sign up via Adwords vs how many sign up via FB ads). You can read how to assign a source when adding a subscriber here.
  • device - string
    Which device the user has used to sign up. This is used mostly for analytics purposes (for example to see how many people sign up via desktop vs how many sign up via mobile). You can read how to assign a source when adding a subscriber here.
  • created_at - unix timestamp
    Unix timestamp (expressed in UTC) of when the subscriber has been added to the list.
  • updated_at - unix timestamp
    Unix timestamp (expressed in UTC) of the last time the subscriber has been updated.

Still need help? Contact Us Contact Us