Kick

Kick

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

{
  "data": {
    "success": true,
    "message": "The member with superhero3 has been kicked from the Group with supergroup."
  }
}

DELETE

groups

{guid}

members

{uid}

Kick

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

{
  "data": {
    "success": true,
    "message": "The member with superhero3 has been kicked from the Group with supergroup."
  }
}

apikey

string

header

required

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

onBehalfOf

string

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

guid

string

required

A GUID of a group.

uid

string

required

An UID of a user.

200 - application/json

Kicked Group Members

The response is of type object.