Skip to main content
POST
/
users
/
invite
cURL
curl --request POST \
  --url https://api.callab.ai/v1/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "jsmith@example.com",
  "password": "<string>",
  "fullname": "<string>",
  "permissions": [
    123
  ]
}'
{
  "status": "<string>",
  "message": "<string>",
  "data": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

User details

​
email
string<email>
required

The email address of the new user

​
fullname
string
required

The full name of the new user

​
permissions
integer[]
required

Array of permission IDs to assign to the user

​
password
string

Optional password for the new user. If omitted, a random password is generated

Response

User added successfully and invitation email sent.

​
status
string

Status of the response, e.g., 'success' or 'error'

​
message
string

A descriptive message for the response

​
data
string

Response data, typically a string for this type of response.