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

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Events - all permissions
Manage Events
Manage Events
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
eventIdstringRequired

Event ID.


optionsCancelEventOptions

Optional fields.

Returns
Return Type:Promise<CancelEventResponse>
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?