v4

latestOpenAPI 3.1.02026-08-08221179273.1 KB
referrals

Redeem Referral Code

Redeem a referral code to get premium access.

Restrictions:

  • Users cannot redeem their own codes
  • Users can only redeem one code (cannot redeem if already redeemed)
  • Code must be active and not expired

Args: request: RedeemCodeRequest with the token (the actual code)

Returns: RedeemCodeResponse with success status and access expiry

post/api/referrals/redeem

Headers

x-user-idstring nullable

Request body

tokenstring required

The referral code to redeem

Response

Successful Response

successboolean required

Whether the redemption was successful

messagestring required

Success or error message