Skip to main content
POST
Referral Conversion

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
affiliate_slug
string
required

URL parameter of the affiliate (i.e. https://company.com?red=john -> john). You can use a competitor slug as well.

advocate_slug
string

required if affiliate_slug is not set - URL parameter of the advocate (i.e. https://company.com?refby=jwe512 -> jwe512).

email
string

required if uid is not set - Email of the referral

uid
string

required if email is not set - Your internal ID of the user/customer

gr_id
string

Cookie set by the tracking script in the referral's browser. Used to match the exact click that converted.

Response

Successful conversion

data
object