Skip to main content
DELETE
/
users
Deactivate
curl --request DELETE \
  --url https://{appId}.api-{region}.cometchat.io/v3/users \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "uidsToDeactivate": [
    "<string>"
  ]
}
'
{
  "data": {
    "deactivatedUids": [
      "cometchat-uid-2",
      "cometchat-uid-3"
    ]
  }
}
For the complete error reference, see Error Guide.

Authorizations

​
apikey
string
header
required

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

Body

application/json
​
uidsToDeactivate
string[]

UIDs that needs to deactivated.

Response

200 - application/json

Deactivated Users

​
data
object