v2

latestOpenAPI 3.0.3Apache 2.02026-07-3149289180.2 KB

Create Account Invite

Create or return the authenticated account's primary invite code. The call is idempotent for accounts that already have a primary invite code.

post/v1/account/invite

Request body

CreateInviteRequest required

Response

Account invite response.

status'ok' required
codestring required

Referral or invite code

referrals_availableinteger required

Remaining lifetime referrals for this invite code.

cooldown_msinteger nullable required

Milliseconds until referrals become available again. Null for lifetime caps because no windowed cooldown applies.

Example response

{
  "code": "ABC123"
}