Sign in

v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

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. <br/> <br/> 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). <br/><br/><Tip>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. <br/><br/> 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.</Tip><Tip>HTTP Request <br/>POST https://api.firstpromoter.com/api/v2/track/signup</Tip>

post/signup

Headers

Account-IDstring required

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

Request body

OR

Response

Successful signup response

idinteger
etypestring
sale_amountinteger nullable
original_sale_amountinteger nullable
original_sale_currencystring nullable
event_idstring nullable
plan_idstring nullable
billing_periodstring nullable
created_atstring date-time

Example response

{
  "id": 45831611,
  "etype": "signup",
  "created_at": "2025-04-25T09:29:51.973Z",
  "referral": {
    "id": 29203686,
    "email": "testme@test1.com"
  },
  "commissions": []
}