Group Members

πŸ“˜

  1. A maximum of 25 users can be added across all the scopes of member object.
  2. 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.

ParametersTypeDescription
adminsarray of stringsA string array of UIDs of the existing users to be added as group admins.
moderatorsarray of stringsA string array of UIDs of the existing users to be added as group moderators.
participantsarray of stringsA string array of UIDs of the existing users to be added as group participants.
usersToBanarray of stringsA 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

  1. admin
  2. moderator
  3. 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:

CodeDescription
ERR_GUID_NOT_FOUNDIndicates that the GUID does not exist.
ERR_ALREADY_JOINEDIndicates that the user has already joined the group.
ERR_GROUP_NOT_JOINEDIndicates that the user(onBehalfOf) has not joined the group.
ERR_UID_NOT_FOUNDIndicates any one of the following:

1. UID does not exist.
2. User is soft deleted.
ERR_SAME_SCOPEIndicates that the existing and new scope are same.
ERR_GROUP_JOIN_NOT_ALLOWEDIndicates that the user is trying to join the private group.
ERR_NO_VACANCYIndicates that the group is full.
ERR_MEMBER_SCOPE_CHANGE_FAILEDIndicates that the has failed to change the scope.
ERR_NOT_A_BANNED_USERIndicates that the API is trying to unban non-banned users.
ERR_BANNED_GROUPMEMBERIndicates that the banned user is trying to access the group features.
ERR_ALREADY_BANNEDThis indicates that the API is trying to ban an already banned user.
ERR_MEMBER_UNBAN_FAILEDIndicates that the API has failed to unban a user for the group.
ERR_GROUP_NO_ADMIN_SCOPEIndicates that the user does not have admin scope in the group.
ERR_GROUP_NO_MODERATOR_SCOPEIndicates that the user does not have moderator scope in the group.
ERR_GROUP_NO_SCOPE_CLEARANCEIndicates that the user does not have permission to change the scope of other user.