Skip to main content
DELETE
/
users
/
{uid}
Delete
curl --request DELETE \
  --url https://{appId}.api-{region}.cometchat.io/v3/users/{uid} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "permanent": "false"
}
'
{
  "data": {
    "success": true,
    "message": "User with cometchat-uid-6 has been deleted successfully."
  }
}

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-flutter-uikit-v6-default.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

For the complete error reference, see Error Guide.
Permanent deletion: By default, deleting a user only deactivates them. To permanently delete a user along with all their messages, conversations, and associated data, you must include permanent: true in the request body. This action is irreversible.

Authorizations

​
apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

​
uid
string
required

An UID of a user.

Body

application/json
​
permanent
boolean
default:false

Permanently deletes the user along with all the messages, conversations, etc.

Response

200 - application/json

Deleted User

​
data
object