deleteBadge( )


Deletes a badge.

The deleteBadge() function returns a Promise that resolves when the specified badge is deleted.

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.

Authentication

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

Permissions
Manage Badges
Learn more about app permissions.
Method Declaration
Copy
function deleteBadge(_id: string): Promise<void>;
Method Parameters
_idstringRequired

Badge ID.

JavaScript
import { badges } from "wix-members.v2"; /* Sample _id value: '50dca3d3-f142-44ca-87e9-d9302e1d4dd5' */ export async function myDeleteBadgeFunction(_id) { try { const deletedBadge = await badges.deleteBadge(_id); console.log("Badge deleted: ", deletedBadge); return deletedBadge; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to void */
Errors

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

Did this help?