Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Update Schedule

Developer Preview

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; this discards any previous array elements.

Permissions
This endpoint requires the Manage Bookings permissions scope

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

PATCH

https://www.wixapis.com/bookings/v1/calendar/schedules/{schedule.id}

Path Params

NAME
TYPE
DESCRIPTION
schedule.id
Required

string

Schedule identifier.

Body Params

NAME
TYPE
DESCRIPTION
fieldMask

object

Field mask of fields to update.

notifyParticipants
Deprecated

boolean

Deprecated, use participant_notification.

alignTimeExceptions

boolean

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

schedule

object

Schedule.

participantNotification

object

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

Response Object

NAME
TYPE
DESCRIPTION
schedule

object

Schedule.

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Update Schedule's capacity

Patch update the capacity of a schedule.

Request

curl

Copy Code
1curl -X PATCH \
2 'https://www.wixapis.com/bookings/v1/calendar/schedules/4ecefd2f-eebc-412e-b45a-a9497b5815cf' \
3 -H "Content-Type: application/json" \
4 -H 'Authorization: <AUTH>' \
5 --data '{
6 "fieldMask": {
7 "paths": [
8 "capacity"
9 ]
10 },
11 "schedule": {
12 "capacity": 25
13 }
14 }'

Response

json

1
2{"schedule": {
3 "id": "4ecefd2f-eebc-412e-b45a-a9497b5815cf",
4 "scheduleOwnerId": "3d7dba43-d214-4149-8a53-a1a4a0c1e636",
5 "firstSessionStart": "2020-04-30T16:00:00Z",
6 "lastSessionEnd": "2021-04-29T19:00:00Z",
7 "timeZone": "America/Denver",
8 "intervals": [ {
9 "id": "a5fb1bcc-5f73-4ae5-b099-17f3772f6b93",
10 "start": "2020-04-28T21:00:00Z",
11 "end": "2021-04-29T20:59:59.999Z",
12 "interval": {
13 "daysOfWeek": "THU",
14 "hourOfDay": 10,
15 "minuteOfHour": 0,
16 "duration": 180
17 },
18 "frequency": {"repetition": 1},
19 "affectedSchedules": [ {
20 "scheduleId": "e07c6328-4495-4b80-b04d-c45f13215881",
21 "transparency": "BUSY",
22 "scheduleOwnerId": "76570209-101f-409b-af97-b445bdb63125"
23 }]
24 }],
25 "title": "Intermediate Ski Class",
26 "tags": ["GROUP"],
27 "location": {"locationType": "OWNER_BUSINESS"},
28 "capacity": 25,
29 "rate": {
30 "labeledPriceOptions": {"general": {
31 "amount": "180",
32 "currency": "USD",
33 "downPayAmount": "0"
34 }},
35 "priceText": ""
36 },
37 "availability": {
38 "start": "2020-04-28T21:00:00Z",
39 "end": "2021-04-29T20:59:59.999Z",
40 "linkedSchedules": []
41 },
42 "totalNumberOfParticipants": 0,
43 "participants": [],
44 "status": "CREATED",
45 "created": "2020-04-29T18:30:58.668Z",
46 "updated": "2020-04-29T20:09:25.333Z",
47 "version": 3,
48 "inheritedFields": []
49}}
Update Interval