API ReferenceRewards & GrowthReferrals

Apply referral code

Apply a referral code to the current user's account.

Authentication

AuthorizationBearer

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

Headers

X-API-Keystring or nullOptional

Request

This endpoint expects an object.
codestringRequired1-20 characters
Referral code to apply

Response

Successful Response
created_atdatetime
idstringformat: "uuid"
statusstring
pending, completed, or expired
completed_atdatetime or null
referee_avatarstring or null

Referee avatar — only present once the referral is COMPLETED (a masked name with a real face would leak identity).

referee_usernamestring or null
rp_amountinteger or null

RP the referrer earned for this referral (null until awarded).

rp_awardedbooleanDefaults to false
Whether RP was awarded to the referrer
stagestringDefaults to signed_up

Derived funnel stage: ‘signed_up’ | ‘verified’ | ‘completed’.

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error