Skip to main content
POST
Remove user from 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. Only agent can be removed; customers cannot be removed from the chat.

Available options:
agent
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 removed from chat.