PATCH

Update Schedule

Deprecated

This method has been replaced with Update Schedule, and will be removed on June 30, 2025.

Updates a schedule. This method supports patch semantics. The field values you specify replace the existing values. Fields that you don’t specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays, and therefore discards any previous array elements. The availability.locations array cannot be updated. Please use the setAvailabilityLocations endpoint instead.

Permissions This endpoint requires the Manage Bookings permissions scope

Endpoint
PATCH
https://www.wixapis.com/bookings/v1/calendar/schedules/{schedule.id}
Path Params
schedule.idstringRequired

Schedule ID.

Body Params
scheduleSchedule

Schedule.

alignTimeExceptionsboolean

Optional. Defaults to false. In case of updated intervals' start time, this field indicates whether to align those interval's time exceptions.

notifyParticipantsbooleandeprecated

Deprecated, use participant_notification.

participantNotificationParticipantNotification

Whether to notify participants about the change, and an optional custom message.

Response Object
scheduleSchedule

Schedule.

Patch update the capacity of a schedule.

Request
cURL
curl -X PATCH \
   'https://www.wixapis.com/bookings/v1/calendar/schedules/4ecefd2f-eebc-412e-b45a-a9497b5815cf' \
   -H "Content-Type: application/json" \
   -H 'Authorization: <AUTH>' \
   --data '{
             "fieldMask": {
               "paths": [
                 "capacity"
               ]
             },
             "schedule": {
               "capacity": 25
             }
           }'
Response
JSON
{
  "schedule": {
    "id": "4ecefd2f-eebc-412e-b45a-a9497b5815cf",
    "scheduleOwnerId": "3d7dba43-d214-4149-8a53-a1a4a0c1e636",
    "firstSessionStart": "2020-04-30T16:00:00Z",
    "lastSessionEnd": "2021-04-29T19:00:00Z",
    "timeZone": "America/Denver",
    "intervals": [
      {
        "id": "a5fb1bcc-5f73-4ae5-b099-17f3772f6b93",
        "start": "2020-04-28T21:00:00Z",
        "end": "2021-04-29T20:59:59.999Z",
        "interval": {
          "daysOfWeek": "THU",
          "hourOfDay": 10,
          "minuteOfHour": 0,
          "duration": 180
        },
        "frequency": {
          "repetition": 1
        },
        "affectedSchedules": [
          {
            "scheduleId": "e07c6328-4495-4b80-b04d-c45f13215881",
            "transparency": "BUSY",
            "scheduleOwnerId": "76570209-101f-409b-af97-b445bdb63125"
          }
        ]
      }
    ],
    "title": "Intermediate Ski Class",
    "tags": [
      "GROUP"
    ],
    "location": {
      "locationType": "OWNER_BUSINESS"
    },
    "capacity": 25,
    "rate": {
      "labeledPriceOptions": {
        "general": {
          "amount": "180",
          "currency": "USD",
          "downPayAmount": "0"
        }
      },
      "priceText": ""
    },
    "availability": {
      "start": "2020-04-28T21:00:00Z",
      "end": "2021-04-29T20:59:59.999Z",
      "linkedSchedules": [
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

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