Create a Member Referral Code

Store a one-time referral code for the member with source set to api. The code is saved exactly as supplied, so the partner system controls its format; no prefix or suffix is added. Another member redeems it later through the standard referral flows (for example a transaction referralCode parameter), which links the two members and awards referral rewards.

The referral loyalty mechanic must be enabled for the project. Codes must be unique within the project across all sources, at most 16 characters long, and must not be exactly 6 characters long because that length is reserved for permanent member referral codes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of Member who owns the code (the referrer)

Body Params
string
required
length between 1 and 16

Referral code to store. Stored as sent (surrounding whitespace trimmed). Must be unique within the project and must not be exactly 6 characters long.

Responses

400

Missing or invalid code (1023), code already exists in the project (1022), or referral mechanic not enabled (32003).

404

Member not found in the project (1001).

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json