Update user availability schedule

PUT 
/calendars/schedules/:id

Modify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated.

Request

Version stringrequired

API Version

Available optionsv3

id stringrequired

Unique identifier of the schedule to update

application/json

application/json

Body

Bodyrequired

namestring

Human-readable name for the schedule

rulesobject[]

Updated schedule rules defining when the schedule is active

timezonestring

Updated timezone for the schedule (IANA timezone identifier)

Possible values: Value must match regular expression ^[A-Za-z_]+/[A-Za-z_]+$

Example (auto)

{
  "name": "Updated Business Hours",
  "rules": [
    {
      "type": "wday",
      "day": "monday",
      "intervals": [
        {
          "from": "08:00",
          "to": "18:00"
        }
      ]
    }
  ],
  "timezone": "America/Los_Angeles"
}

application/json

Schedule updated successfully

application/json

Schema

Schema

scheduleobjectrequired

Schedule

Example (auto)

{
  "schedule": {
    "id": "IkqiJlXJ7o9h61tCHHod",
    "name": "Business Hours Schedule",
    "locationId": "ocQHyuzHvysMo5N5VsXc"
  }
}