Skip to main content
POST
/
v0
/
settings
/
users
Invites a user
curl --request POST \
  --url https://{hostname}.gable.ai/v0/settings/users \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "resendInvite": true,
  "role": "ADMIN"
}
'
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
email
string
required

The email address of the user, which is the primary ID in Gable

Pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
firstName
string

The first name of the user

lastName
string

The last name of the user

resendInvite
boolean

The flag which determines whether the invitation should be resent

role
enum<string>

The role of the user

Available options:
ADMIN,
EDITOR,
VIEWER

Response

User was invited to Gable