cancelEvent( )


Cancels an event.

After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to 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 method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
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?