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

Request

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

Changes

No recorded changes to this operation across all 23 revisions of this API.