Update

Updates the group details for a given GUID.

PUT /groups/{guid}

Update

cURL

curl --request PUT \
  --url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "public",
  "password": "<string>",
  "icon": "<string>",
  "description": "<string>",
  "metadata": {},
  "owner": "<string>",
  "tags": [
    "tag1"
  ],
  "unset": [
    "icon"
  ]
}
'

200

{
  "data": {
    "guid": "project-group",
    "name": "Project Group",
    "description": "project related discussions between members",
    "icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp",
    "type": "public",
    "scope": "admin",
    "membersCount": 1,
    "joinedAt": 1638440784,
    "conversationId": "group_project-group",
    "hasJoined": true,
    "createdAt": 1638440784,
    "owner": "cometchat-uid-4",
    "tags": [
      "friends",
      "project"
    ]
  }
}

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.

Body

application/json

name · string

Name of the group.

type · enum<string>

The type of the group. The available values are: public, password and private.

Available options: public, password, private

password · string

A password required to join the the group with type password

icon · string

An URL for a group icon.

description · string

Description about the group

metadata · object

Additional group data.

owner · string

The UID that you wish to make the owner of the group.This field will be ignored if onBehalfOf parameter in the header is present in the request.

tags · string[]

Updates tags of a group.

unset · enum<string>[]

The unsettable user attributes are icon, description and metadata.

Group attributes that can be unset.

Available options: icon, description, metadata

Response

200 - application/json

Get group

data · object