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
).
_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.
POST https://firstpromoter.com/api/v1/track/signup
Authorizations
Query Parameters
required if uid is null
Email of the lead/sign-up
required if email is null
ID to match the sale with the lead if the email can be changed before the first sale. If the sales are tracked by our built-in integrations and not by our API, the uid
must match customer ID on Stripe, Braintree, Chargebee, Recurly. Since Stripe doesn't allow pre-defined customer id, you can also pass the uid
value as fp_uid
in customer metadata later, when you create the customer object.
required if ref_id is null
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. Grab that value from the cookie and pass it here to match the lead with the referral.
required if tid is null
Default referral id of the promoter. Use this only when you want to assign the lead to a specific promoter.
IP of the visitor who generated the sign up. It's used for fraud analysis.
Email of the promoter
ISO date string of the date of the signup event
Set this to true
to skip email notifications. Default is false
.