deleteEvent( )

Permanently deletes an event.

You can retrieve the deleted event through a GDPR access request.

Admin Method

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

Syntax

function deleteEvent(eventId: string): Promise<DeleteEventResponse>

deleteEvent Parameters

NAME

TYPE

DESCRIPTION

eventId

string

Event ID.

Returns

Return Type:

Promise<

DeleteEventResponse

NAME

TYPE

DESCRIPTION

eventId

string

Deleted event ID.

Was this helpful?

deleteEvent example

Copy Code

1import { wixEventsV2 } from 'wix-events.v2';
2  
3 async function deleteEvent(eventId) {
4   try {
5     const result = await wixEventsV2.deleteEvent(eventId);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13