Skip to main content
POST
/
settings
/
company
/
invite
/
Invite Staff Member
curl --request POST \
  --url https://api.getoutbox.ai/settings/company/invite/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "role": 2
}
'

Authorizations

​
Authorization
string
header
required

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

Body

​
email
string<email>
required
Minimum string length: 1
​
role
integer
required

Permission level (1=read, 2=read+write agent config, 3=admin, 4=owner).

Required range: 1 <= x <= 4

Response

200

Invitation sent (or staff added directly if the user already exists).