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

Update Session

Developer Preview

Updates a session.
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/sessions/{session.id}

Path Params

NAME
TYPE
DESCRIPTION
session.id
Required

string

Identifier for this session when session is a single session or generated from recurring interval. Optional.

Body Params

NAME
TYPE
DESCRIPTION
notifyParticipants
Deprecated

boolean

Deprecated, use participant_notification

updated

object

Field mask of fields to update.

session
Required

object

Session.

participantNotification

object

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

deleted

object

Session fields to revert to empty, in order to revert to the data inherited from the schedule.

Response Object

NAME
TYPE
DESCRIPTION
session

object

Session.

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Update Session's time

Update the start & end times of a session using the "updated" field mask.

Request

curl

Copy Code
1curl -X PATCH \
2 'https://www.wixapis.com/bookings/v1/calendar/sessions/2mmoW0vwKcSFyxtOfCdMr5jzNtbCs62lQ62AcLzRcPOZFywzW4Ei3WJC79mkE1rRreylI1FCRYfP3MB36naHxEou7NieV8Cfdbu1' \
3 -H "Content-Type: application/json" \
4 -H 'Authorization: <AUTH>' \
5 --data '{
6 "session": {
7 "scheduleId": "03d67e9c-5ba9-4e73-ad9e-7fddc57c6c4e",
8 "start": {
9 "timestamp": "2020-04-16T11:30:00.000-07:00"
10 },
11 "end": {
12 "timestamp": "2020-04-16T12:30:00.000-07:00"
13 }
14 },
15 "updated": {
16 "paths": [
17 "start",
18 "end"
19 ]
20 }
21 }'

Response

json

1
2{"session": {
3 "id": "2mmoW0vwKcSFyxtOfCdMr5jzNtbCs62lQ62AcLzRcPOZFywzW4Ei3WJC79mkE1rRreylI1FCRYfP3MB36naHxEou7NieV8Cfdbu1",
4 "scheduleId": "03d67e9c-5ba9-4e73-ad9e-7fddc57c6c4e",
5 "scheduleOwnerId": "9b33d0b6-bcd2-408b-ac9d-f164504a16e2",
6 "start": {
7 "timestamp": "2020-04-16T18:30:00Z",
8 "timeZone": "America/Denver"
9 },
10 "end": {
11 "timestamp": "2020-04-16T19:30:00Z",
12 "timeZone": "America/Denver"
13 },
14 "affectedSchedules": [ {
15 "scheduleId": "06be0abc-8a6a-4b7b-93c1-70d053ffd97f",
16 "transparency": "BUSY",
17 "scheduleOwnerId": "1d6a2248-34e7-4bbc-a6e3-bf0ce71f594f"
18 }],
19 "title": "Intermediate Ski Lesson (members only)",
20 "tags": ["GROUP"],
21 "location": {"locationType": "OWNER_BUSINESS"},
22 "capacity": 50,
23 "rate": {
24 "labeledPriceOptions": {},
25 "priceText": "Free"
26 },
27 "notes": "",
28 "totalNumberOfParticipants": 0,
29 "participants": [],
30 "inheritedFields": [
31 "rate",
32 "location",
33 "tags",
34 "externalCalendarOverrides",
35 "title",
36 "capacity"
37 ],
38 "status": "CONFIRMED",
39 "type": "EVENT"
40}}
Update Session's rate