Update a schedule

Changed on Apr 15, 2026

<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>

patch/v2/schedules/{scheduleId}

Request

The document declares no server URL.
Auth: none declared. Required headers: Authorization, cal-api-version

Path parameters

scheduleIdstring required

Headers

Authorizationstring required

value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token

cal-api-versionstring required

Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version.

Request body

namestring

timeZonestring

isDefaultboolean

Example request

{
  "name": "One-on-one coaching",
  "timeZone": "Europe/Rome",
  "availability": [
    {
      "days": [
        "Monday",
        "Tuesday"
      ],
      "startTime": "09:00",
      "endTime": "10:00"
    }
  ],
  "isDefault": true,
  "overrides": [
    {
      "date": "2024-05-20",
      "startTime": "12:00",
      "endTime": "14:00"
    }
  ]
}

Response

status'success' | 'error' required

errorobject

Example response

{
  "status": "success",
  "data": {
    "id": 254,
    "ownerId": 478,
    "name": "Catch up hours",
    "timeZone": "Europe/Rome",
    "availability": [
      {
        "days": [
          "Monday",
          "Tuesday"
        ],
        "startTime": "17:00",
        "endTime": "19:00"
      },
      {
        "days": [
          "Wednesday",
          "Thursday"
        ],
        "startTime": "16:00",
        "endTime": "20:00"
      }
    ],
    "isDefault": true,
    "overrides": [
      {
        "date": "2024-05-20",
        "startTime": "18:00",
        "endTime": "21:00"
      }
    ]
  }
}

Changes

Apr 15, 2026v216de9d3eb7b3 Revision changes
- breaking
  removed the enum value Friday of the request property //
- breaking
  removed the enum value Monday of the request property //
- breaking
  removed the enum value Saturday of the request property //
- breaking
  removed the enum value Sunday of the request property //
- breaking
  removed the enum value Thursday of the request property //
- breaking
  removed the enum value Tuesday of the request property //
- breaking
  removed the enum value Wednesday of the request property //
- info
  removed the pattern TIME_FORMAT_HH_MM from the request property //
- info
  removed the pattern TIME_FORMAT_HH_MM from the request property //
- info
  removed the pattern TIME_FORMAT_HH_MM from the request property //
- info
  removed the pattern TIME_FORMAT_HH_MM from the request property //
- info
  removed the Friday enum value from the /// response property for the response status
- info
  removed the Monday enum value from the /// response property for the response status
- info
  removed the Saturday enum value from the /// response property for the response status
- info
  removed the Sunday enum value from the /// response property for the response status
- info
  removed the Thursday enum value from the /// response property for the response status
- info
  removed the Tuesday enum value from the /// response property for the response status
- info
  removed the Wednesday enum value from the /// response property for the response status
- info
  the /// response's property pattern TIME_FORMAT_HH_MM was removed for the status
- info
  the /// response's property pattern TIME_FORMAT_HH_MM was removed for the status
- info
  the /// response's property pattern TIME_FORMAT_HH_MM was removed for the status
- info
  the /// response's property pattern TIME_FORMAT_HH_MM was removed for the status
Sep 26, 2025v2daa3e48bc03a Revision changes
- breaking
  request property // was restricted to a list of enum values
- breaking
  added the pattern TIME_FORMAT_HH_MM to the request property //
- breaking
  added the pattern TIME_FORMAT_HH_MM to the request property //
- breaking
  added the pattern TIME_FORMAT_HH_MM to the request property //
- breaking
  added the pattern TIME_FORMAT_HH_MM to the request property //
- warning
  added the new Friday enum value to the /// response property for the response status
- warning
  added the new Monday enum value to the /// response property for the response status
- warning
  added the new Saturday enum value to the /// response property for the response status
- warning
  added the new Sunday enum value to the /// response property for the response status
- warning
  added the new Thursday enum value to the /// response property for the response status
- warning
  added the new Tuesday enum value to the /// response property for the response status
- warning
  added the new Wednesday enum value to the /// response property for the response status
- info
  added the new Friday enum value to the request property //
- info
  added the new Monday enum value to the request property //
- info
  added the new Saturday enum value to the request property //
- info
  added the new Sunday enum value to the request property //
- info
  added the new Thursday enum value to the request property //
- info
  added the new Tuesday enum value to the request property //
- info
  added the new Wednesday enum value to the request property //
- info
  the /// response's property pattern TIME_FORMAT_HH_MM was added for the status
- info
  the /// response's property pattern TIME_FORMAT_HH_MM was added for the status
- info
  the /// response's property pattern TIME_FORMAT_HH_MM was added for the status
- info
  the /// response's property pattern TIME_FORMAT_HH_MM was added for the status

Operation history