- A maximum of 25 users can be added across all the scopes of member object.
- For a group with more than 300 members, the conversations and unread message counts are not updated.
The following table lists the properties of an HTTP request that Group Members API supports.
| Parameters | Type | Description |
|---|---|---|
| admins | array of strings | A string array of UIDs of the existing users to be added as group admins. |
| moderators | array of strings | A string array of UIDs of the existing users to be added as group moderators. |
| participants | array of strings | A string array of UIDs of the existing users to be added as group participants. |
| usersToBan | array of strings | A string array of UIDs of the existing users to be added as group participants. |
The individual member failure can be seen in the error objects in their respective scope.
If the same UID is added to more than one scopes array then the UID will get the scopes in the order below
- admin
- moderator
- participant
For example, if the UID superhero1 is part of admins, moderators, and usersToBan arrays then it will appear in the only members.admins property in the response.
The following table lists the most common error codes the Group Members API may return in case of an error:
| Code | Description |
|---|---|
| ERR_GUID_NOT_FOUND | Indicates that the GUID does not exist. |
| ERR_ALREADY_JOINED | Indicates that the user has already joined the group. |
| ERR_GROUP_NOT_JOINED | Indicates that the user(onBehalfOf) has not joined the group. |
| ERR_UID_NOT_FOUND | Indicates any one of the following: 1. UID does not exist. 2. User is soft deleted. |
| ERR_SAME_SCOPE | Indicates that the existing and new scope are same. |
| ERR_GROUP_JOIN_NOT_ALLOWED | Indicates that the user is trying to join the private group. |
| ERR_NO_VACANCY | Indicates that the group is full. |
| ERR_MEMBER_SCOPE_CHANGE_FAILED | Indicates that the has failed to change the scope. |
| ERR_NOT_A_BANNED_USER | Indicates that the API is trying to unban non-banned users. |
| ERR_BANNED_GROUPMEMBER | Indicates that the banned user is trying to access the group features. |
| ERR_ALREADY_BANNED | This indicates that the API is trying to ban an already banned user. |
| ERR_MEMBER_UNBAN_FAILED | Indicates that the API has failed to unban a user for the group. |
| ERR_GROUP_NO_ADMIN_SCOPE | Indicates that the user does not have admin scope in the group. |
| ERR_GROUP_NO_MODERATOR_SCOPE | Indicates that the user does not have moderator scope in the group. |
| ERR_GROUP_NO_SCOPE_CLEARANCE | Indicates that the user does not have permission to change the scope of other user. |