Update A Group

Update group details such as name, type, icon, and description using the CometChat JavaScript SDK.

AI Integration Quick Reference

// Update group details
const group = new CometChat.Group("GUID", "New Name", CometChat.GROUP_TYPE.PUBLIC);
const updated = await CometChat.updateGroup(group);

Update Group

Use updateGroup() to modify group details. Pass a Group object with the updated values.

TypeScript

const GUID: string = "GUID";
const groupName: string = "Hello Group!";
const groupType: string = CometChat.GROUP_TYPE.PUBLIC;

const group: CometChat.Group = new CometChat.Group(GUID, groupName, groupType);

CometChat.updateGroup(group).then(
  (group: CometChat.Group) => {
      console.log("Group details updated successfully:", group);
  }, (error: CometChat.CometChatException) => {
      console.log("Group details update failed with exception:", error);
  }
);

JavaScript

const GUID = "GUID";
const groupName = "Hello Group";
const groupType = CometChat.GROUP_TYPE.PUBLIC;
const group = new CometChat.Group(GUID, groupName, groupType);

CometChat.updateGroup(group).then(
group => {
  console.log("Groups details updated successfully:", group);
}, error => {
  console.log("Group details update failed with exception:", error);
}
);

Parameter	Description
group	An instance of Group class with updated values

On success, returns a Group object with the updated details.

The method returns a Group object. Access the response data using getter methods:

Field	Getter	Return Type	Description
guid	getGuid()	string	Unique group ID
name	getName()	string	Display name of the group
type	getType()	string	Group type ("public", "private", or "password")
description	getDescription()	string	Description of the group
icon	getIcon()	string	URL of the group icon
owner	getOwner()	string	UID of the group owner
updatedAt	getUpdatedAt()	number	Timestamp when the group was last updated

There is no real-time event listener available to receive updated group details when the updateGroup() method is called. To get the latest group information, you need to fetch the group details again using the appropriate method.

For more information on the Group class, please check here.

---

Next Steps

Delete Group

Permanently delete a group

Retrieve Groups

Fetch and filter groups with pagination