deleteMember( )

Deletes a member.

Description

Note: This function permanently deletes a member. Once deleted, a member cannot be restored.

This function is not a universal function and runs only on the backend.

Admin Method

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

Syntax

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

deleteMember Parameters

NAME

TYPE

DESCRIPTION

_id

string

ID of the member to delete.

Returns

Return Type:

Promise<

void

Was this helpful?

Delete a member by ID (export from backend code)

Copy Code

1import { members } from 'wix-members.v2';
2import { webMethod, Permissions } from 'wix-web-module';
3import { elevate } from 'wix-auth';
4
5const elevatedDeleteMember = elevate(members.deleteMember);
6
7/* Sample _id value: '29ae2752-73d2-4a07-8cba-677e1928ed52' */
8
9export const myDeletedMemberFunction = webMethod(
10  Permissions.Anyone,
11  async (_id) => {
12    try {
13      const deletedMember = await elevatedDeleteMember(_id);
14      console.log('Deleted member:', deletedMember);
15
16      return deletedMember;
17    } catch (error) {
18      console.error(error);
19      // Handle the error
20    }
21  }
22);
23
24/* Promise resolves to void */
25