removeMembers( )


Removes site members from an assigned badge.

The removeMembers() function returns a Promise that resolves when the specified members are removed as holders of the specified badge.

The badgeId parameter must be an ID from your site's Members/Badges collection. Typically, you retrieve the ID from the collection using a query or through a dataset.

Method Declaration
Copy
function removeMembers(
  badgeId: string,
  memberIds: Array<string>,
): Promise<void>;
Method Parameters
badgeIdstringRequired

ID of the badge to remove the members from.


memberIdsArray<string>Required

IDs of the members to remove from the badge.

Remove members from an assigned badge
JavaScript
import { Permissions, webMethod } from "wix-web-module"; import { badges } from "wix-members-backend"; export const myRemoveMembersFunction = webMethod(Permissions.Anyone, () => { const badgeId = "3fcaacc0-a3a7-464f-9ba9-f211bdcec9fc"; const memberIds = [ "efab296e-2687-4751-9956-ee73200dd4bb", "3403e13b-8826-4af6-aa19-18784bb84a8e", "28d35f86-6694-4455-9dff-aff5d450b482", ]; return badges .removeMembers(badgeId, memberIds) .then(() => { console.log("Members removed from badge"); }) .catch((error) => { console.error(error); }); });
Errors

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

Did this help?