Delete

Delete a CometChat group by GUID with REST API to remove a multi-user conversation and its group resource.

DELETE /groups/{guid}

Delete

cURL

curl --request DELETE \
  --url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid} \
  --header 'apikey: <api-key>'

200

{
  "data": {
    "success": true,
    "message": "Group with guid project-group has been deleted successfully."
  }
}

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).

Headers

onBehalfOf · string

UID of the user on whose behalf the action is performed.

Path Parameters

guid · string · required

A GUID of a group.

Response

200 - application/json

Deleted Group

data · object