deleteBadge( )

Deletes a badge.

Description

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.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function deleteBadge(_id: string): Promise<void>

deleteBadge Parameters

NAME

TYPE

DESCRIPTION

_id

string

Badge ID.

Returns

Return Type:

Promise<

void

Was this helpful?

Delete existing badge. (dashboard page code)

Copy Code

1import { badges } from 'wix-members.v2';
2
3/* Sample _id value: '50dca3d3-f142-44ca-87e9-d9302e1d4dd5' */
4
5export async function myDeleteBadgeFunction(_id) {
6  try {
7    const deletedBadge = await badges.deleteBadge(_id);
8
9    console.log("Badge deleted: ", deletedBadge);
10    return deletedBadge;
11  } catch (error) {
12    console.error(error);
13    // Handle the error
14
15  }
16
17}
18
19/* Promise resolves to void */

Delete existing badge. (export from backend code)

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { badges } from 'wix-members.v2';
3import { elevate } from 'wix-auth';
4
5/* Sample _id value: '50dca3d3-f142-44ca-87e9-d9302e1d4dd5' */
6
7export const myDeleteBadgeFunction = webMethod(Permissions.Anyone, async (_id) => {
8  try {
9    const elevatedDeleteBadge = elevate(badges.deleteBadge);
10    const deletedBadge = await elevatedDeleteBadge(_id);
11
12    console.log("Badge deleted: ", deletedBadge);
13    return deletedBadge;
14  } catch (error) {
15    console.error(error);
16    // Handle the error
17
18  }
19
20});
21
22/* Promise resolves to void */
23