Skip to main content
POST
/
api
/
v1
/
users
/
{user_id}
/
invitation-code
Generate Invitation Code
curl --request POST \
  --url https://api.example.com/api/v1/users/{user_id}/invitation-code \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
user_id
string<uuid>
required

Response

Successful Response

Response schema after generating an invitation code.

​
id
string<uuid>
required
​
code
string
required
​
user_id
string<uuid>
required
​
expires_at
string<date-time>
required
​
created_at
string<date-time>
required