Skip to main content
POST
/
api
/
v1
/
invitation-code
/
redeem
Redeem Invitation Code
curl --request POST \
  --url https://api.example.com/api/v1/invitation-code/redeem \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'
{
  "access_token": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token_type": "bearer",
  "refresh_token": "<string>",
  "expires_in": 123
}

Body

application/json

API input for redeeming an invitation code.

code
string
required
Required string length: 8
Pattern: ^[A-Z2-9]{8}$

Response

Successful Response

Redeem response with user_id included.

access_token
string
required
user_id
string<uuid>
required
token_type
string
default:bearer
refresh_token
string | null
expires_in
integer | null