POST

Cancel Event


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

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

Permissions
Manage Events - all permissions
Manage Events
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v3/events/{eventId}/cancel

Path Params
eventIdstringRequired

Event ID.

Body Params
fieldsArray <string>maxItems 20

Predefined sets of fields to return. If both fields and fieldsets are sent in the request, the union of both lists is returned.

Response Object
eventEvent

Canceled event.

Cancel event
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v3/events/fc31ba0c-95bc-40d3-a816-70bf85f1e951/cancel' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"] }'
Response
JSON
{ "event": { "id": "217b6eed-f580-43e4-974a-6cc0bfa4b58a", "location": { "name": "San Jose Convention Center", "type": "VENUE", "address": { "country": "US", "subdivision": "CA", "city": "San Jose", "postalCode": "95113", "streetAddress": { "number": "150", "name": "West San Carlos Street", "apt": "", "formattedAddressLine": null }, "addressLine2": null, "formattedAddress": "150 W San Carlos St, San Jose, CA 95113, USA", "hint": null, "geocode": { "latitude": 37.3284838, "longitude": -121.8881933 }, "countryFullName": "United States", "subdivisions": [ { "code": "CA", "name": "California", "type": "ADMINISTRATIVE_AREA_LEVEL_1", "typeInfo": null }, { "code": "Santa Clara County", "name": "Santa Clara County", "type": "ADMINISTRATIVE_AREA_LEVEL_2", "typeInfo": null }, { "code": "San Jose", "name": "San Jose", "type": "ADMINISTRATIVE_AREA_LEVEL_3", "typeInfo": null }, { "code": "Downtown San Jose", "name": "Downtown San Jose", "type": "ADMINISTRATIVE_AREA_LEVEL_4", "typeInfo": null }, { "code": "US", "name": "United States", "type": "COUNTRY", "typeInfo": null } ], "subdivisionFullName": null }, "locationTbd": false }, "dateAndTimeSettings": { "dateAndTimeTbd": false, "dateAndTimeTbdMessage": null, "startDate": "2023-11-10T16:00:00Z", "endDate": "2023-11-13T01:00:00Z", "timeZoneId": "America/Yellowknife", "hideEndDate": false, "showTimeZone": false, "recurrenceStatus": "ONE_TIME", "recurringEvents": { "individualEventDates": [], "categoryId": null }, "formatted": { "dateAndTime": "10 November 2023 at 09:00 – 12 November 2023 at 18:00", "startDate": "10 November 2023", "startTime": "09:00", "endDate": "12 November 2023", "endTime": "18:00" } }, "title": "TechXpo 2023: Innovation and Future Trends Unveiled", "shortDescription": "", "mainImage": null, "slug": "techxpo-2023-innovation-and-future-trends-unveiled", "languageCode": "en", "createdDate": "2023-07-12T11:07:35.059Z", "updatedDate": "2023-07-12T11:12:52Z", "status": "CANCELED", "registration": null, "calendarUrls": null, "eventPageUrl": null, "form": null, "summaries": null, "instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b", "guestListSettings": { "displayedPublicly": true }, "userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "feed": null, "onlineConferencing": { "enabled": false, "providerId": null, "providerName": "", "type": -1, "session": null }, "seoSettings": null, "contactLabel": "custom.techxpo-2023-innovation-and-future-trends-unveiled", "agendaSettings": null, "categories": [] } }
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?