cancelEvent( )

Cancels an event.

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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Events - all permissions
Manage Events
Manage Events
Learn more about app permissions.
Method Declaration
Copy
function cancelEvent(
  eventId: string,
  options: CancelEventOptions,
): Promise<CancelEventResponse>;
Method Parameters
eventIdstringRequired

Event ID.

optionsCancelEventOptions

Optional fields.

Returns
Return Type:Promise<CancelEventResponse>
JavaScript
import { wixEventsV2 } from "@wix/events";

async function cancelEvent(eventId, options) {
  const response = await wixEventsV2.cancelEvent(eventId, options);
}
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?