removeGroupMembers( )

Removes site members from a specific group.

Only group admins can remove members from their group.

Method Declaration
Copy
function removeGroupMembers(
  groupId: string,
  memberIds: Array<string>,
): Promise<void>;
Method Parameters
groupIdstringRequired

Group ID.

memberIdsArray<string>Required

Member IDs. See the Members API for details.

JavaScript
import { members } from "@wix/groups";

async function removeGroupMembers(groupId, memberIds) {
  const response = await members.removeGroupMembers(groupId, memberIds);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?