Update Group Details

Use this API to update group details

JSON Parameter Description:

Parameter

Required

Description

groupId

No

Group unique identifier

clientGroupId

No

Client Group unique identifier

newName

No

New name of the group

imageUrl

No

New image url of the group profile image

metadata

No

Key value pair in Json

📘

Note:

  • Pass either groupId or clientGroupId.

  • In case of Application Bot calling the API, Of-User-Id header is required.
    Of-User-Id is the userId of the user on behalf of which application bot wants to update the group details.

To change role of group members:

Group Admin can update any group user's role by passing following request body:

{
  "clientGroupId": "group unique identifier",
  "users": [
    {
      "userId": "user unique identifier",
      "role": 1
    },
    {
      "userId": "user unique identifier",
      "role": 1
    }
  ]
}

Possible values of role:

Parameter

Value

Description

Privilege

role

1

role will be admin

Full Access to group

role

2

role will be moderator

Add/remove users, Group Info update

role

3

role will be member

Group Info update

To update group metadata:

Group Admin can update group's existing metadata value and can pass new metadata as well in request body:

{
  "clientGroupId": "226583",
  "metadata":{
    "HIDE":"true",
    "GROUP_ICON_CHANGE_MESSAGE": "Icon Changed"
  }
}
Language
Authentication
Click Try It! to start a request and see the response here!