Skip to main content
PUT
/
users
Update User
curl --request PUT \
  --url https://api.contextual.ai/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "is_tenant_admin": false,
  "roles": [
    "VISITOR"
  ]
}
'
{}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The schema used for creating new users or updating existing users.

​
email
string
required

The email of the user

​
is_tenant_admin
boolean
default:false

Flag indicating if the user is a tenant admin

​
roles
enum<string>[]

The user level roles of the user.

Available options:
VISITOR,
AGENT_USER,
CUSTOMER_USER,
CUSTOMER_INTERNAL_USER,
CONTEXTUAL_STAFF_USER,
CONTEXTUAL_EXTERNAL_STAFF_USER,
CONTEXTUAL_INTERNAL_STAFF_USER,
TENANT_ADMIN,
CUSTOMER_ADMIN,
CONTEXTUAL_ADMIN,
SUPER_ADMIN,
SERVICE_ACCOUNT

Response

Successful Response

The response is of type EmptyResponse · object.