Skip to main content
POST
/
settings
/
invite
Invite Staff Member
curl --request POST \
  --url https://api.getoutbox.ai/settings/invite \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": 2
}
'

Authorizations

​
Authorization
string
header
required

Company API Key

Body

application/json

Invitation details

​
email
string<email>
required

Email address of the user to invite

​
role
integer
required

Permission level (1=read, 2=write, 3=create, 4=admin)

Required range: 1 <= x <= 4

Response

Staff member invited successfully