Remove Users from a Chat

Remove one or more users from a chat. Users that are not currently assigned are skipped.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Body Params
string
required

The chat to remove users from.

userIds
array of strings
required

User IDs to remove from the chat. Max 50.

userIds*
Responses

400

Bad request — invalid body

401

Unauthorized

403

Forbidden — role not permitted

404

Chat not found in your organisation

429

Too many requests

500

Internal server error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json