Skip to main content
POST
/
public
/
admin
/
users
Add Clerk chat user
curl --request POST \
  --url https://web-api.clerk.chat/public/admin/users \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "role": "workspace_owner"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "role": "<string>",
  "firstName": "<string>",
  "lastName": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clerk.chat/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
apiKey
string
header
required

Body

application/json

Request to add a new Clerk chat user

​
email
string
required

Email of the user to add

​
firstName
string

First name of the user to add

​
lastName
string

Last name of the user to add

​
role
enum<string>

Role of the user

Available options:
workspace_owner,
admin,
manager,
agent,
member

Response

The created Clerk chat user

Response containing Clerk chat user information

​
id
string
required

The ID of the created user

​
email
string
required

The email of the created user

​
role
string
required

The role of the created user

​
firstName
string

The first name of the created user

​
lastName
string

The first name of the created user