removeGroupMembers( )

Removes members from a group.

Description

The removeGroupMembers() function returns a Promise that resolves when the member is removed from the group.

Note: Only site admins and group admins can remove members from their group. However, if the suppressAuth option is set to true, all permissions are overwritten and all site members (including non-group members) can remove members from a group.

Syntax

function removeGroupMembers(identifiers: IdentifiersRemoveGroupMembers, [options: Options]): Promise<void>

removeGroupMembers Parameters

NAME

TYPE

DESCRIPTION

identifiers

IdentifiersRemoveGroupMembers

Group ID and member IDs.

options

Optional

Options

Authorization options.

Returns

Return Type:

Promise<void>

Was this helpful?

Remove a site member from a group

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { members } from 'wix-groups-backend';
3
4// Sample identifiers value:
5// {
6//   groupId: '0261a737-2361-4468-a3b1-5ec2b0667836',
7//   memberIds: ['937cd3db-e9be-4980-93c1-a6d767a11050', '7fe8e9e1-d050-4c86-9684-e7f231600a34']
8// }
9//
10// Sample options value:
11// {
12//   suppressAuth: true
13// }
14
15export const myRemoveGroupMembersFunction = webMethod(Permissions.Anyone, (identifiers, options) => {
16  return members.removeGroupMembers(identifiers, options)
17    .then((removedGroupMembers) => {
18      console.log('Removed group members');
19    })
20    .catch((error) => {
21      console.error(error);
22    });
23});