Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.cometchat.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Certain actions can be performed on the group members:
  1. Kick a member from the group
  2. Ban a member from the group.
  3. Unban a member from the group.
  4. Update the scope of the member of the group.
All the above actions can only be performed by the Admin or the Moderator of the group. Banning a user API doesn’t accept body parameters.
It simply bans the UID mentioned in the path parameter of the request. The banned user will be no longer part of the group and can not perform any actions in the group. A banned user cannot rejoin the same group without being unbanned.

​
Available operations

MethodEndpointDescription
POST/groups/{guid}/banned_membersBan a user from a group
GET/groups/{guid}/banned_membersList all banned members of a group
DELETE/groups/{guid}/banned_members/{uid}Unban a user from a group

​
Banned user properties

PropertyTypeDescription
uidstringUID of the banned user
scopestringFormer scope of the user in the group before being banned
bannedAtintegerUNIX timestamp of when the user was banned

​
Error handling

Error CodeDescription
AUTH_ERR_EMPTY_APIKEYAPI key is missing from the request headers
AUTH_ERR_APIKEY_NOT_FOUNDThe provided API key is invalid
ERR_GUID_NOT_FOUNDThe specified group GUID does not exist
ERR_UID_NOT_FOUNDThe specified user UID does not exist
For the complete list of error codes, see Error Guide.