Skip to main content
POST
Invite people to the workspace

Authorizations

Authorization
string
header
required

Body

application/json
emails
string<email>[]
required

The addresses to invite. They are stored in lowercase.

Required array length: 1 - 100 elements
role
enum<string>
default:user

The workspace role each invited person gets.

Available options:
admin,
user,
external,
partner

Response

Created

success
boolean
Example:

true

status
integer
Example:

201

data
object
Last modified on November 1, 2026