Skip to main content
POST
/
v1
/
invites
Create Invite
curl --request POST \
  --url http://localhost:8000/v1/invites \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "role": "USER"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "role": "USER",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "invite_link": "<string>",
  "accepted_at": "2023-11-07T05:31:56Z",
  "email_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.knowledgestack.ai/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
authorization
string | null

Cookies

​
ks_uat
string | null

Body

application/json
​
tenant_id
string<uuid>
required
​
email
string<email>
required
​
role
enum<string>
default:USER

Tenant user role.

Available options:
USER,
OWNER,
ADMIN

Response

Response Create Invite · object | null

Successful Response

Invite response model.

​
id
string<uuid>
required
​
tenant_id
string<uuid>
required
​
email
string<email>
required
​
role
enum<string>
required

Tenant user role.

Available options:
USER,
OWNER,
ADMIN
​
expires_at
string<date-time>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
invite_link
string
required
​
accepted_at
string<date-time> | null
​
email_id
string<uuid> | null