friends-and-family

Redeem Invite

Authenticated user: redeem an invite code.

Idempotent in the sense that if the user is already F&F, redemption still bumps use_count by 1 (an audit trail of who clicked the link). The Supabase admin API call to set app_metadata is fail-soft — if the supabase auth call fails, the redemption row is still written so the owner can manually backfill via /api/admin/users/{id}/role.

post/api/ff/redeem/{code}

Request

  • Base URL: https://api.equity-rank.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.equity-rank.com/api/ff/redeem/{code}
  • Auth: HTTP bearer

Path parameters

codestring required

Request body

acknowledgment_displayedboolean required

MUST be true when the invite has acknowledgment_required=true. Frontend sets this AFTER displaying the F&F memo and capturing user assent.

Response

Successful Response

redeemedboolean required
invite_idinteger required
user_idstring required
next_stepsstring

Changes

No recorded changes to this operation across all 1 revision of this API.