Overview

Add, remove, list, and update CometChat group members with REST APIs, including member scopes and group permissions.

The Group Members API manages the membership of users within a group. Each member is assigned a scope that determines their permissions inside the group.

Key behaviors

• A maximum of 25 users can be added per API call across all scope arrays (admins, moderators, participants, usersToBan).
• If the same UID appears in multiple scope arrays, the highest scope applies in the order: admin > moderator > participant.
• Individual member addition failures do not cause the overall request to fail — check the error objects in the response for per-member status.
• For groups with more than 300 members, conversations and unread message counts are not updated.

Member scopes

Scope	Default assignment	Privileges
admin	Group creator	Change member scopes, add/kick/ban members, update/delete group, send & receive messages & calls
moderator	Promoted by an admin	Change scope of participants, kick & ban participants, update group, send & receive messages & calls
participant	All other members	Send & receive messages & calls

How group members connect to other resources

• Groups — Members belong to a Group, identified by its GUID.
• Users — Each member is a User, identified by their UID.
• Banned Users — Members can be banned from a group by admins or moderators.
• Roles & RBAC — A member’s app-wide Role is checked alongside their group scope. Both must allow an action for it to succeed. See RBAC & SBAC.

Available operations

Operation	Method	Endpoint	Description
List Members	GET	/groups/{guid}/members	Retrieve all members of a group
Add Members	POST	/groups/{guid}/members	Add users to a group with specified scopes
Change Scope	PUT	/groups/{guid}/members/{uid}	Change a member’s scope within the group
Kick Member	DELETE	/groups/{guid}/members/{uid}	Remove a member from the group

Group member properties

Property	Type	Description
admins	array of strings	UIDs of users to be added as group admins.
moderators	array of strings	UIDs of users to be added as group moderators.
participants	array of strings	UIDs of users to be added as group participants.
usersToBan	array of strings	UIDs of users to be banned from the group.

Error handling

Error Code	Description
ERR_GUID_NOT_FOUND	The specified group does not exist
ERR_UID_NOT_FOUND	The specified user does not exist
ERR_NOT_A_MEMBER	The user is not a member of this group
ERR_ALREADY_JOINED	The user is already a member of this group

For the complete list of error codes, see Error Guide.

For all system limits (member caps, group thresholds, etc.), see Properties and Constraints.