POST
/
signup

Authorizations

X-API-KEY
string
headerrequired

Query Parameters

email
string

required if uid is null

Email of the lead/sign-up

uid
string

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.

tid
string

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.

ref_id
string

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
string

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

promoter_email
string

Email of the promoter

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

200 - application/json
id
integer
type
string
amount_cents
integer | null
reward
string | null
lead
object
promoter
object