Delete

Deactivate a CometChat user by UID with REST API, or permanently delete the user and related data with permanent: true.

DELETE /users/{uid}

Delete

cURL

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"
}
'

200

{
  "data": {
    "success": true,
    "message": "User with cometchat-uid-6 has been deleted successfully."
  }
}

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