cURL

curl --request POST \
  --url https://api.firstpromoter.com/api/v2/track/signup \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "uid": "<string>",
  "tid": "<string>",
  "ref_id": "<string>",
  "ip": "<string>",
  "created_at": "<string>",
  "skip_email_notification": true
}
'

{
  "id": 45831611,
  "etype": "signup",
  "sale_amount": null,
  "original_sale_amount": null,
  "original_sale_currency": null,
  "event_id": null,
  "plan_id": null,
  "billing_period": null,
  "created_at": "2025-04-25T09:29:51.973Z",
  "referral": {
    "id": 29203686,
    "email": "[email protected]",
    "uid": null
  },
  "commissions": []
}

Tracking Api

Tracking leads and sign-ups

Capture a lead when they sign-up or fill an optin form. This endpoint is used to track leads and sign-ups. It’s not for tracking the actual sales and commissions.

Sign-ups are tracked as leads in FirstPromoter so when a person referred by the promoter/affiliate signs up, a new referral should be added inside FirstPromoter (you can see them inside the Referrals section as Leads).

The recommended way to do this is to grab the _fprom_tid (_fprom_track for accounts created prior to April 2021) cookie value(which keeps the tracking id and referral identification) on your server and send it along with the sign-up data through the tid parameter.

Alternative: In some special cases, you can refer sign ups directly to a promoter, by passing the referral id through ref_id parameter. Be careful when using this because the referral id can be modified by the promoter by default, however you can disable that from the campaign configuration page.

HTTP Request
POST https://api.firstpromoter.com/api/v2/track/signup

POST

signup

cURL

curl --request POST \
  --url https://api.firstpromoter.com/api/v2/track/signup \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "uid": "<string>",
  "tid": "<string>",
  "ref_id": "<string>",
  "ip": "<string>",
  "created_at": "<string>",
  "skip_email_notification": true
}
'

{
  "id": 45831611,
  "etype": "signup",
  "sale_amount": null,
  "original_sale_amount": null,
  "original_sale_currency": null,
  "event_id": null,
  "plan_id": null,
  "billing_period": null,
  "created_at": "2025-04-25T09:29:51.973Z",
  "referral": {
    "id": 29203686,
    "email": "[email protected]",
    "uid": null
  },
  "commissions": []
}

Authorizations

Authorization

string

header

required

API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys

Headers

Account-ID

string

required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Body

application/json

Option 1
Option 2

string

required

Email of the lead/sign-up. Required if uid is not provided.

uid

string

ID to match the sale with the lead if the email can be changed before the first sale. Required if email is not provided.

tid

string

Visitor tracking ID. It's set when the visitor tracking script tracks the referral visit on our system. The value is found inside _fprom_tid cookie. Required if ref_id is not provided.

ref_id

string

Default referral id of the promoter. Use this only when you want to assign the lead to a specific promoter. Required if tid is not provided.

string

IP of the visitor who generated the sign up. It's used for fraud analysis.

created_at

string

ISO date string of the date of the signup event

skip_email_notification

boolean

Set this to true to skip email notifications. Default is false.

Response

Successful signup response

integer

Example:

45831611

etype

string

Example:

"signup"

sale_amount

integer | null

Example:

null

original_sale_amount

integer | null

Example:

null

original_sale_currency

string | null

Example:

null

event_id

string | null

Example:

null

plan_id

string | null

Example:

null

billing_period

string | null

Example:

null

created_at

string<date-time>

Example:

"2025-04-25T09:29:51.973Z"

referral

object

Show child attributes

referral.id

integer

Example:

29203686

referral.email

string

Example:

"[email protected]"

referral.uid

string | null

Example:

null

commissions

any[]

Example:

[]

Show progress Tracking sales and commissions

⌘I

API Documentation

Batch Processes

Tracking Api

Referrals

Promoters

Promoter Campaigns

Commissions

Promo Codes

Payouts

Reports

Tracking leads and sign-ups

Authorizations

Headers

Body

Response