POST

Bulk Cancel Event


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels multiple events in bulk.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage Bookings
Manage Calendars
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/calendar/v3/bulk/events/cancel

Body Params
eventIdsArray <string>RequiredminItems 1maxItems 50

IDs of the events to cancel.


returnEntityboolean

Whether to return the canceled events.

Default: false


participantNotificationParticipantNotification

Information about whether participants of the canceled events are notified and the message they receive.


timeZonestring

Time zone in IANA tz database format for calculating adjustedStart and adjustedEnd. For example, America/New_York or UTC.

Default: timeZone specified in the business site properties.

Response Object
resultsArray <BulkEventResult>

The result for each event, containing the event and whether the action was successful.


bulkActionMetadataBulkActionMetadata

Total successes and failures.

Bulk Cancel Event

Cancels multiple events.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/calendar/v3/bulk/events/cancel' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "eventIds": [ "37e01b7f71374c06bca502eb435c1503b26e5434815a4e7ca6ac9be4783c5482", "37e01b7f71374c06bca502eb435c1503c0d77e8daef74681952c80b1bfd42d3d" ] }'
Response
JSON
{ "results": [ { "itemMetadata": { "id": "37e01b7f71374c06bca502eb435c1503b26e5434815a4e7ca6ac9be4783c5482", "originalIndex": 0, "success": true } }, { "itemMetadata": { "id": "37e01b7f71374c06bca502eb435c1503c0d77e8daef74681952c80b1bfd42d3d", "originalIndex": 1, "success": true } } ], "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0 } }
Errors
428Failed Precondition

There is 1 error with this status code.

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

Event TriggersThis method triggers the following events:
Did this help?