Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json
code
string
required
label
string | null

Response

Referral code created

binds
integer<int64>
required

Number of users who bound through this specific code (users.bound_via_code_id).

Required range: x >= 0
clicks
integer<int64>
required

Number of recorded clicks that resolved to this code (referral_clicks.code_id).

Required range: x >= 0
code
string
required
code_id
string
required
created_at
integer<int64>
required
downline_count
integer<int64>
required

Total direct downline of this code's owner (users.referrer_id). Owner-level, so it is identical across all of the owner's codes.

Required range: x >= 0
is_default
boolean
required
label
string | null