Update A Group

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

Quick Reference for AI Agents & Developers

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

Available via: SDK | REST API | UI Kits

Update Group

In other words, as a group owner, how can I update the group details?

You can update the existing details of the group using the updateGroup() method.

Update Group

var GUID = "GUID";
var groupName = "Hello Group";
var groupType = CometChat.GROUP_TYPE.PUBLIC;
var 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);
}
);

TypeScript

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

var 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);
  }
);

This method takes an instance of the Group class as a parameter which should contain the data that you wish to update.

Parameter	Description
group	an instance of class Group

After a successful update of the group, you will receive an instance of Group class containing update information of the group.

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