Chats

remove user from chat (v2)

Auth: User JWT

remove user from chat (v2)

delete/v2/chats/users-access

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/chats/users-access
  • Auth: HTTP bearer

Request body

chatNamestring

Internal chat name in the form <appId>_<chatId>. Returned by every chat-listing endpoint as chats[].name.

membersstring[]

Array of xmppUsername strings (<appId>_<userId>) to add or remove from the room. Already-member adds and not-yet-member removes are no-ops.

Response 

{
  results: [string],           // removed xmpp usernames only
  details: [{ xmppUsername, status, code? }], // per-member outcome (idempotent)
}
okboolean required
resultsstring[] required

Example response

{
  "ok": true,
  "details": [
    {
      "status": "added"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.