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.
function addGroupMembers(
groupId: string,
memberIds: Array<string>,
options: AddGroupMembersOptions,
): Promise<AddGroupMembersResponse>;
Group ID.
IDs of the site members to add to the group.
import { members } from "wix-groups.v2";
// Sample groupId value: '0261a737-2361-4468-a3b1-5ec2b0667836'
//
// Sample memberIds value: ['937cd3db-e9be-4980-93c1-a6d767a11050', '7fe8e9e1-d050-4c86-9684-e7f231600a34']
async function addGroupMembers(groupId, memberIds) {
try {
const result = await members.addGroupMembers(groupId, memberIds);
return result;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* members: [
* {
* "joinedDate": "Sun Aug 01 2021 12:32:35 GMT+0300"
* "memberId": "437cd3db-e9be-4980-93c1-a6d767a11050"
* "role": {"value": "ADMIN"}
* },
* {
* "joinedDate": "Tues Jun 30 2019 10:09:33 GMT+0300"
* "memberId": "7fe8e9e1-d050-4c86-9684-e7f231600a34"
* "role": {"value": "MEMBER"}
* }
* ]
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.