Skip to main content
POST
/
v1
/
invitations
Create Invitation
curl --request POST \
  --url https://api.example.com/v1/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "role": "viewer",
  "team_ids": [
    "<string>"
  ]
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
email
string
required
Required string length: 3 - 200
​
role
enum<string>
default:viewer
Available options:
admin,
analyst,
viewer
​
team_ids
string[] | null

Response

Successful Response