Kick

Remove a CometChat group member using GUID and UID parameters to manage membership through the REST API.

DELETE /groups/{guid}/members/{uid}

Kick

cURL

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

200

{
  "data": {
    "success": true,
    "message": "The member with cometchat-uid-3 has been kicked from the Group with cometchat-guid-1."
  }
}

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.

uid · string · required

An UID of a user.

Response

200 - application/json

Kicked Group Members

data · object