Skip to main content
POST
Invite user

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json
email
string<email>
required

Address to invite; an invitation email is sent

Maximum string length: 320
roleId
string<uuid>
required

Role to assign (GET /roles)

fullName
string

Defaults to the email prefix

Maximum string length: 200
companyId
string<uuid>

Invite as a company (client portal) user of this company; omit for MSP staff

Response

User invited or linked

data
object
required