Users

Archive (soft-delete) or purge users in a target app (v2, tenant actor)

Auth: Tenant Actor

Default behavior is soft archive: each user's status flips to archived, login is blocked, and all related data (wallets, files, chat memberships, XMPP account) is retained for restore via POST /v2/apps/{appId}/users/{userId}/restore.

Pass ?mode=hard for a synchronous cascade purge (irreversible): per user, XMPP unregister, MinIO blob removal, wallets, files, docs, memberships, ACL, refresh tokens, sessions, and any rooms the user created (room destroy + chat row + messages + members of that room).

Returns per-user results so the caller can act on partial failures.

Supports User JWT and B2B Server JWT.

delete/v2/apps/{appId}/users/batch

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/apps/{appId}/users/batch
  • 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.

Query parameters

mode'soft' | 'hard'

soft (default): reversible archive. hard: full cascade purge.

reasonstring

Optional human-readable explanation stored with the archive.

Request body

usersIdListstring[] required

Array of User IDs to operate on. Users must belong to the target App.

Response

ok (per-user results in results[])

Changes

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