POST
/
api
/
invitation
Send Invitation
curl --request POST \
  --url https://api.trieve.ai/api/invitation \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Organization: <tr-organization>' \
  --data '{
  "app_url": "<string>",
  "email": "<string>",
  "redirect_uri": "<string>",
  "scopes": [
    "<string>"
  ],
  "user_role": 123
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Organization
string<uuid>
required

The organization id to use for the request

Body

application/json

JSON request payload to send an invitation

​
app_url
string
required

The url of the app that the user will be directed to in order to set their password. Usually admin.trieve.ai, but may differ for local dev or self-hosted setups.

​
email
string
required

The email of the user to invite. Must be a valid email as they will be sent an email to register.

​
redirect_uri
string
required

The url that the user will be redirected to after setting their password.

​
user_role
integer
required

The role the user will have in the organization. 0 = User, 1 = Admin, 2 = Owner.

​
scopes
string[] | null

The api route scopes the user will have in the organization.

Response

Ok response. Indicates that invitation email was sent correctly.