Change Scope

Change a CometChat group member scope using GUID and UID parameters to update permissions through the REST API.

PUT /groups/{guid}/members/{uid}

Change Scope

cURL

curl --request PUT \
  --url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members/{uid} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "scope": "participant"
}
'

200

{
  "data": {
    "guid": "cometchat-guid-1",
    "uid": "cometchat-uid-2",
    "scope": "participant",
    "joinedAt": 1631690303
  }
}

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.

Body

application/json

scope · string · default: participant

A scope for the user.

Response

200 - application/json

Changed Scope of Group Members

data · object

Show child attributes