This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates an event.
When updating an event with {"recurrenceType": "INSTANCE"}
, the
recurrenceType
automatically changes to EXCEPTION
.
When updating an event with {"recurrenceType": "MASTER"}
:
INSTANCE
and EXCEPTION
events remain unchanged.INSTANCE
events, all relevant fields are updated.EXCEPTION
events, only changes to the inheritedFields
are
applied, while other fields remain unchanged.You can only call this method when authenticated as a Wix app or Wix user identity.
Event ID.
Event to update.
Information about whether participants of the updated event are notified and the message they receive.
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.
Updated event.
Updates an event's title.
curl -X PATCH \
'https://www.wixapis.com/calendar/v3/events/913c4d89-f9bf-4b21-8572-d2c79ece382e' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"event": {
"title": "Hip Hop Groove (+ Special Guests)",
"revision": "2"
}
}'
{
"event": {
"id": "913c4d89-f9bf-4b21-8572-d2c79ece382e",
"scheduleId": "132db383-1378-4903-820b-4eebf4242de2",
"externalScheduleId": "4187d1f3-38a2-4cfd-b8f1-6333cd012e33",
"scheduleName": "Hip Hop Groove",
"type": "CLASS",
"status": "CONFIRMED",
"title": "Hip Hop Groove (+ Special Guests)",
"start": {
"localDate": "2024-10-31T13:00:00",
"timeZone": "Europe/Dublin",
"utcDate": "2024-10-31T13:00:00Z"
},
"end": {
"localDate": "2024-10-31T14:00:00",
"timeZone": "Europe/Dublin",
"utcDate": "2024-10-31T14:00:00Z"
},
"adjustedStart": {
"localDate": "2024-10-31T13:00:00",
"timeZone": "Europe/Dublin"
},
"adjustedEnd": {
"localDate": "2024-10-31T14:00:00",
"timeZone": "Europe/Dublin"
},
"timeZone": "Europe/Dublin",
"recurrenceType": "NONE",
"transparency": "OPAQUE",
"location": {
"type": "BUSINESS"
},
"resources": [
{
"id": "c27dfdce-666a-4e56-8933-be249f2011b7",
"name": "Emily",
"type": "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155",
"scheduleId": "99fb6b69-8c8f-4578-bd7f-f11a87a88aad",
"transparency": "OPAQUE",
"permissionRole": "WRITER"
}
],
"totalCapacity": 50,
"remainingCapacity": 50,
"inheritedFields": ["CAPACITY", "TIME_ZONE", "CONFERENCING_DETAILS"],
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"permissions": [],
"revision": "3",
"createdDate": "2024-10-13T19:01:16.619Z",
"updatedDate": "2024-10-13T19:02:25.364Z"
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.