PATCH

Update Session

Deprecated

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

Updates a session. The property values specified replace the existing values. If a property is not specified in the request it will remain unchanged. Array properties, if specified, overwrite the existing array and all of its elements. The participants array cannot be updated. Use the participantNotification property to send an email to the participants notifying them of the change.

Permissions This endpoint requires the Manage Bookings permissions scope

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

Session ID.

Body Params
sessionSessionRequired

Session.

notifyParticipantsbooleandeprecated

Deprecated. Use participant_notification.

participantNotificationParticipantNotification

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

Response Object
sessionSession

Session.

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

Request
cURL
curl -X PATCH \
   'https://www.wixapis.com/bookings/v1/calendar/sessions/2mmoW0vwKcSFyxtOfCdMr5jzNtbCs62lQ62AcLzRcPOZFywzW4Ei3WJC79mkE1rRreylI1FCRYfP3MB36naHxEou7NieV8Cfdbu1' \
   -H "Content-Type: application/json" \
   -H 'Authorization: <AUTH>' \
   --data '{
             "session": {
               "scheduleId": "03d67e9c-5ba9-4e73-ad9e-7fddc57c6c4e",
               "start": {
                 "timestamp": "2020-04-16T11:30:00.000-07:00"
               },
               "end": {
                 "timestamp": "2020-04-16T12:30:00.000-07:00"
               }
             },
             "updated": {
               "paths": [
                 "start",
                 "end"
               ]
             }
           }'
Response
JSON
{
  "session": {
    "id": "2mmoW0vwKcSFyxtOfCdMr5jzNtbCs62lQ62AcLzRcPOZFywzW4Ei3WJC79mkE1rRreylI1FCRYfP3MB36naHxEou7NieV8Cfdbu1",
    "scheduleId": "03d67e9c-5ba9-4e73-ad9e-7fddc57c6c4e",
    "scheduleOwnerId": "9b33d0b6-bcd2-408b-ac9d-f164504a16e2",
    "start": {
      "timestamp": "2020-04-16T18:30:00Z",
      "timeZone": "America/Denver"
    },
    "end": {
      "timestamp": "2020-04-16T19:30:00Z",
      "timeZone": "America/Denver"
    },
    "affectedSchedules": [
      {
        "scheduleId": "06be0abc-8a6a-4b7b-93c1-70d053ffd97f",
        "transparency": "BUSY",
        "scheduleOwnerId": "1d6a2248-34e7-4bbc-a6e3-bf0ce71f594f"
      }
    ],
    "title": "Intermediate Ski Lesson (members only)",
    "tags": [
      "GROUP"
    ],
    "location": {
      "locationType": "OWNER_BUSINESS"
    },
    "capacity": 50,
    "rate": {
      "labeledPriceOptions": {
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?