bulkCancelEventsByFilter( )

Cancels multiple events that meet the given criteria.

Description

After cancellation, registration for an event is closed. To reuse the event, clone and publish it again. If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.

Admin Method

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

Syntax

function bulkCancelEventsByFilter(options: BulkCancelEventsByFilterOptions): Promise<void>

bulkCancelEventsByFilter Parameters

NAME

TYPE

DESCRIPTION

options

Optional

BulkCancelEventsByFilterOptions

Optional fields.

Returns

Return Type:

Promise<

void

Was this helpful?

bulkCancelEventsByFilter example

Copy Code

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