Skip to main content
POST
Add user to chat
Required scopes: or

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
chat_id
string
required

The chat ID.

user_id
string
required

The user ID.

user_type
enum<string>
required

The user type.

Available options:
agent,
customer
visibility
enum<string>
required

Visibility of the user in the chat. customer must be added with all.

Available options:
all,
agents
ignore_requester_presence
boolean
default:false

If true: the requester doesn't need to be present on the list of chat users.

Response

200

User added to chat.