Skip to main content
POST
Set Referrer

Authorizations

Authorization
string
header
required

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

Body

application/json
referrer
string
required

Account identifier of the user who is referring (will be registered if doesn't exist)

referral
string
required

Account identifier of the user being referred (will be registered if doesn't exist, cannot be same as referrer)

platform
string
required

Platform for both users' accounts

pid
string
required

Campaign ID (must belong to the authenticated organization)

Response

Referral relationship successfully established.

success
boolean
Example:

true

data
object

Empty data object