v1

latestOpenAPI 3.1.02026-08-06230114.0 KB

Schedules

Update a Schedule

put/v1/schedules/{scheduleId}

Path parameters

scheduleIdstring required

Headers

Authorizationstring

User access token

Content-Type'application/json'

Request body

namestring

Name of the schedule

referenceTzstring

Time zone identifier for the schedule

Example request

{
  "name": "Weekday Work Hours",
  "referenceTz": "America/Chicago",
  "schedule": [
    {
      "daysOfWeek": [
        1,
        2,
        3,
        4,
        5
      ],
      "times": [
        {
          "startTime": 28800,
          "endTime": 61200
        }
      ]
    }
  ]
}

Response

Returns the updated schedule

idstring required

Unique identifier for the schedule

namestring required

Name of the schedule

referenceTzstring required

Time zone identifier for the schedule

Example response

{
  "id": "65f8a2b4c9d7e1234567890f",
  "name": "Weekday Work Hours",
  "referenceTz": "America/Chicago",
  "schedule": [
    {
      "daysOfWeek": [
        1,
        2,
        3,
        4,
        5
      ],
      "times": [
        {
          "startTime": 28800,
          "endTime": 61200
        }
      ]
    }
  ]
}