Skip to main content
POST
/
v1
/
invites
Invite user
curl --request POST \
  --url https://api.example.com/v1/invites \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tokenId": "123",
  "email": "[email protected]",
  "name": "John Doe",
  "role": "Admin",
  "policy": "Admin"
}
'
{
  "tokenId": "123",
  "email": "[email protected]",
  "name": "John Doe",
  "code": "code-123",
  "permissionId": "permissionId-123",
  "org": "orgId"
}
Invite a user to sign up to the platform

Authorizations

Authorization
string
header
required

Body

application/json
tokenId
string
required
email
string<email>
name
string
role
string
policy
string

Response

201 - application/json

ok

tokenId
string
required
email
string<email>
name
string
code
string
permissionId
string
org
string