Skip to main content
POST
POST
Sends an invitation email to the specified address, granting them a role within the caller’s organisation. Requires the settings:team:add permission.

​
Request Body

​
string
required
Email address of the person to invite.
​
string
required
UUID of the role to assign to the invited user.

​
Response

​
boolean
true when the invitation email has been sent.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
email
string<email>
required
​
role_id
string<uuid>
required

Response

Invitation sent