Skip to main content
POST
/
organizations
/
{slug}
/
invitations
cURL
curl --request POST \
  --url https://api.avala.ai/api/v1/organizations/{slug}/invitations/ \
  --header 'Content-Type: application/json' \
  --header 'X-Avala-Api-Key: <api-key>' \
  --data '
{
  "invited_email": "jsmith@example.com",
  "role": "owner",
  "status": "pending",
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "invited_email": "jsmith@example.com",
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_name": "<string>",
  "organization_slug": "<string>",
  "invited_by_username": "<string>",
  "role": "owner",
  "status": "pending",
  "expires_at": "2023-11-07T05:31:56Z",
  "is_expired": true,
  "accept_url": "<string>",
  "copy_link": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Avala-Api-Key
string
header
required

API key for authentication. Generate one in Mission Control Settings > Security & Identity.

Path Parameters

​
slug
string
required

Body

application/json
​
invited_email
string<email>
required
Required string length: 1 - 254
​
role
enum<string>

Role the user will have when they accept the invitation

Available options:
owner,
admin,
member
​
status
enum<string>
Available options:
pending,
accepted,
expired,
cancelled
​
expires_at
string<date-time>

Response

201 - application/json
​
invited_email
string<email>
required
Required string length: 1 - 254
​
uid
string<uuid>
​
organization_name
string
Minimum string length: 1
​
organization_slug
string
Minimum string length: 1
​
invited_by_username
string | null
Minimum string length: 1
​
role
enum<string>

Role the user will have when they accept the invitation

Available options:
owner,
admin,
member
​
status
enum<string>
Available options:
pending,
accepted,
expired,
cancelled
​
expires_at
string<date-time>
​
is_expired
boolean

Whether the invitation has expired

​
accept_url
string

URL for accepting the invitation

​
copy_link
string

Shareable link for the invitation

​
created_at
string<date-time>