Skip to main content
POST
cURL

Authorizations

X-API-KEY
string
header
required

Query Parameters

email
string

required if uid is null

Email of the subscriber.

uid
string

required if email is null

Unique identifier for the subscriber in your system.

tid
string

Visitor tracking ID from the _fprom_tid cookie. Required if ref_id is not provided.

ref_id
string

Promoter's referral ID. Use this to assign the subscriber directly to a promoter when tid is not available.

ip
string

IP address of the subscriber. Used for fraud analysis.

promoter_email
string

Email of the promoter to assign this subscriber to.

created_at
string<date-time>

ISO 8601 date string of when the subscription occurred. Defaults to now.

skip_email_notification
boolean

Set to true to suppress email notifications. Default is false.

username
string

Username of the subscriber.

first_name
string

First name of the subscriber.

last_name
string

Last name of the subscriber.

website
string

Website of the subscriber.

custom_fields
object

JSON object of custom field key-value pairs.

Response

Subscriber tracked successfully.

id
integer
Example:

44812309

type
string
Example:

"subscriber"

lead
object
promoter
object