POST

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 an event.

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/events/{eventId}/cancel

Path Params
eventIdstringRequired

ID of the event to cancel.

Body Params
participantNotificationParticipantNotification

Information about whether participants of the canceled event 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
eventEvent

Canceled event.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/calendar/v3/events/bb2ce57e-5e18-440c-ae91-8c47338915cf/cancel' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "event": { "id": "bb2ce57e-5e18-440c-ae91-8c47338915cf", "scheduleId": "45b8287f-1549-42d0-bbf3-d6c959902bbf", "externalScheduleId": "d9f64edf-3056-476c-8209-b8fd0d702ce2", "scheduleName": "Aromatherapy", "type": "APPOINTMENT", "status": "CANCELLED", "title": "Aromatherapy", "start": { "localDate": "2024-10-10T10:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-10T09:00:00Z" }, "end": { "localDate": "2024-10-10T11:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-10T10:00:00Z" }, "adjustedStart": { "localDate": "2024-10-10T10:00:00", "timeZone": "Europe/Dublin" }, "adjustedEnd": { "localDate": "2024-10-10T11:00:00", "timeZone": "Europe/Dublin" }, "timeZone": "Europe/Dublin", "recurrenceType": "NONE", "transparency": "OPAQUE", "location": { "type": "BUSINESS" }, "resources": [ { "id": "76570209-101f-409b-af97-b445bdb63125", "name": "Staff Member #1", "type": "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155", "scheduleId": "1010c0ae-bb34-40f7-bbba-c1dd6fc97943", "transparency": "OPAQUE" } ], "totalCapacity": 1, "remainingCapacity": 1, "inheritedFields": [ "TITLE", "CAPACITY", "TIME_ZONE", "CONFERENCING_DETAILS" ], "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "permissions": [], "revision": "2", "createdDate": "2024-10-07T07:39:04.242Z", "updatedDate": "2024-10-07T07:45:37.258Z" } }
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?