Add Members To A Group - CometChat Docs

Add Members to Group

Use addMembersToGroup() to add members to a Group.

Parameter	Description
`GUID`	The group to add members to
`members`	Array of GroupMember objects (UID and scope required)
`bannedMembers`	Array of UIDs to ban (can be empty)

TypeScript
JavaScript

let GUID: string = "GUID";
let UID: string = "UID";
let membersList: CometChat.GroupMember[] = [
  new CometChat.GroupMember(UID, CometChat.GROUP_MEMBER_SCOPE.PARTICIPANT),
];

CometChat.addMembersToGroup(GUID, membersList, []).then(
(response: Object) => {
console.log("response", response);
},
(error: CometChat.CometChatException) => {
console.log("Something went wrong", error);
}
);

let GUID = "GUID";
let UID = "UID";
let membersList = [
  new CometChat.GroupMember(UID, CometChat.GROUP_MEMBER_SCOPE.PARTICIPANT),
];

CometChat.addMembersToGroup(GUID, membersList, []).then(
  (response) => {
    console.log("response", response);
  },
  (error) => {
    console.log("Something went wrong", error);
  }
);

The method returns a response object where each key is a UID and the value is either "success" or an error message describing why that user couldn’t be added.

Real-Time Group Member Added Events

When a group member is added by another member, this event is triggered. When a user joins a group on their own, the joined event is triggered.

Implement onMemberAddedToGroup() in GroupListener to receive real-time notifications when members are added.

TypeScript
JavaScript

const listenerID: string = "UNIQUE_LISTENER_ID";

CometChat.addGroupListener(
listenerID,
new CometChat.GroupListener({
onMemberAddedToGroup: (
message: CometChat.Action,
userAdded: CometChat.User,
userAddedBy: CometChat.User,
userAddedIn: CometChat.Group
) => {
console.log("User joined", {
message,
userAdded,
userAddedBy,
userAddedIn,
});
},
})
);

const listenerID = "UNIQUE_LISTENER_ID";

CometChat.addGroupListener(
  listenerID,
  new CometChat.GroupListener({
    onMemberAddedToGroup: (message, userAdded, userAddedBy, userAddedIn) => {
      console.log("User joined", {
        message,
        userAdded,
        userAddedBy,
        userAddedIn,
      });
    },
  })
);

Always remove group listeners when they’re no longer needed (e.g., on component unmount or page navigation). Failing to remove listeners can cause memory leaks and duplicate event handling.

CometChat.removeGroupListener("UNIQUE_LISTENER_ID");

Missed Member Added Events

When fetching previous messages, member additions appear as Action messages (a subclass of BaseMessage).

Field	Value/Type	Description
`action`	`"added"`	The action type
`actionOn`	User	The user who was added
`actionBy`	User	The user who added the member
`actionFor`	Group	The group the member was added to

Next Steps

Kick & Ban Members

Remove or ban members from a group

Change Member Scope

Promote or demote group members

Retrieve Group Members

Fetch the list of members in a group

Join a Group

Allow users to join public or password-protected groups

​Add Members to Group

​Real-Time Group Member Added Events

​Missed Member Added Events

​Next Steps

Kick & Ban Members

Change Member Scope

Retrieve Group Members

Join a Group

Add Members to Group

Real-Time Group Member Added Events

Missed Member Added Events

Next Steps