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.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Method Declaration
Copy
Method Parameters
groupIdstringRequired

Group ID.


memberIdsArray<string>Required

IDs of the site members to add to the group.


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