addGroupMembers( )

Adds site members to a group.

The addGroupMembers() function returns a Promise that resolves to the newly-added group member after the member has successfully been added.

For SECRET groups, site admins, group admins, and group members can add additional members to their group.

For PUBLIC and PRIVATE groups, only site admins and group admins can add additional members to their group. They can also choose to allow all group members to add a new member to the group. This setting can be found in your site's Dashboard under Groups Application > Your Group > Admin Tools > Member Permissions.

Note: If the suppressAuth option is set to true, all permissions are overwritten and all site members (including non-group members) can add additional members to a group.

Method Declaration
Copy
Method Parameters
identifiersIdentifiersAddGroupMembersRequired

Group ID and member IDs.

optionsOptions

Authorization options.

Returns
Return Type:Promise<GroupMember>
Was this helpful?
Yes
No