Chats

Remove chat members in a target app (v2, tenant actor)

Auth: Tenant Actor

Removes members from an app-scoped chat. Supports User JWT and B2B Server JWT.

delete/v2/apps/{appId}/chats/users-access

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/apps/{appId}/chats/users-access
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

appIdstring required

Target App ID. Must be an app the calling actor owns or has been delegated access to.

Request body

chatNamestring required

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

membersstring[] required

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

ok

Changes

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