Ban

Ban

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

{
  "data": {
    "success": true,
    "message": "The user with uid superhero3 has been banned from the Group with supergroup."
  }
}

POST

groups

{guid}

bannedusers

{uid}

Ban

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

{
  "data": {
    "success": true,
    "message": "The user with uid superhero3 has been banned 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

Create Group

data

object