Authentication
The API uses an API key to authenticate access. You may insert the provided API key in your requests header Authorization like the following:
Authorization: Bearer {API key}
The other option is to add the API key in the key parameter for every requests.
Subscribers
New Subscriber
POST /api/subscription/{Subscription ID}
Insert the ID of the subscription you want the user to subscribe. If user not existing then we create it. If exists we update it.
Query Parameters
|
Parameters |
Description |
|---|---|
|
key |
API key provided. Required if not set in request Authorization header. |
|
|
Required. Email of the subscriber. |
|
external_id |
Required. External ID of the subscriber. Must be a number. |
|
source |
String identifier of source. Default to ‘api’ if not set. |
|
first_name |
First name of the subscriber. |
|
last_name |
Last name of the subscriber. |
|
password |
Password of the subscriber. (if empty, a random one will be generated) |
|
phone_number |
Phone number of the user format should be → 1234567890 |
|
live_scanner |
simply true or false (this is only if you use scanner with F2-Tech) |
Subscribe Member To Multiple Subscriptions at once
POST /api/member/subscribe
This endpoint creates or updates a member and subscribes them to one or more subscription plans.
|
Parameters |
Description |
|---|---|
|
key |
API key provided. Required if not set in request Authorization header. |
|
|
Required. Email of the subscriber. |
|
external_id |
Required. External ID of the subscriber. Must be a number. |
|
source |
String identifier of source. Default to ‘api’ if not set. |
|
first_name |
First name of the subscriber. |
|
last_name |
Last name of the subscriber. |
|
password |
Password of the subscriber. (if empty, a random one will be generated) |
|
phone_number |
Phone number of the user format should be → 1234567890 |
|
live_scanner |
True or false (this is only if you use scanner with F2-Tech) |
|
welcome_email |
True or false. Determines if welcome email should be sent. Default is true. |
|
subs_ids |
Array of subscription IDs to subscribe the user to. |
Please understand the subs_ids need to be an array. In system like infusionsoft you might need to input it like this:
subs_ids[0] = 1
subs_ids[1] = 2
subs_ids[2] = 3
Cancel Subscriptions
POST /api/subscription/delete/{Subscription ID}
Insert the ID of the subscription you want the user to unsubscribe.
|
Parameters |
Description |
|---|---|
|
key |
API key provided. Required if not set in request Authorization header. |
|
|
Required. Email of the user to unsubscribe. |
Members
Update member data
/api/member/update/{external ID}
Insert the external ID of the user you want to update.
All parameters are optional. For example, you can add only the email if this is the only data that you wish to update. external_id and source are used to identify the user to update and must match a previously added member.
|
Parameters |
Description |
|---|---|
|
key |
API key provided. Required if not set in request Authorization header. |
|
external_id |
Required. External ID of the user. |
|
source |
String identifier of source. |
|
|
New user email. |
|
first_name |
New first name of the user. |
|
last_name |
New last name of the user. |
|
password |
New password of the user. |
|
phone_number |
Phone number of the user format should be → 1234567890 |
|
live_scanner |
True or false |