Skip to main content
POST
/
admin
/
organizations
/
{org_id}
/
invitations
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role_name": "<string>",
  "invited_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "accepted_at": "2023-11-07T05:31:56Z",
  "created_by_platform_admin": true,
  "token": "<string>",
  "role_slug": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
org_id
string<uuid>
required

Body

application/json

Create an organization invitation from the platform admin console.

​
email
string<email>
required
​
role_slug
enum<string>
default:organization-owner
Available options:
organization-owner,
organization-admin,
organization-member

Response

Successful Response

Create response containing the raw invitation token.

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
email
string<email>
required
​
role_id
string<uuid>
required
​
role_name
string
required
​
status
enum<string>
required

Invitation lifecycle status.

Available options:
pending,
accepted,
revoked
​
invited_by
string<uuid> | null
required
​
expires_at
string<date-time>
required
​
created_at
string<date-time>
required
​
accepted_at
string<date-time> | null
required
​
created_by_platform_admin
boolean
required
​
token
string
required
​
role_slug
string | null