v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

TimePlanning > PlanningVersion

Updates a Planning version

put/api/2026-07-01/resources/time_planning/planning_versions/{id}

Path parameters

idstring required

Planning version identifier

Request body

idstring required

Planning version identifier

effective_atstring required

Planning version start date

number_of_rest_days_in_centsinteger

Amount of rest days per week if applicable (in cents)

planning_toolstring required

Type of planning tool (shift_management, work_schedules, contract_hours)

schedule_idstring

Work schedule identifier to include if applicable

Example request

{
  "id": "1",
  "effective_at": "2020-09-07",
  "number_of_rest_days_in_cents": 200,
  "planning_tool": "shift_management",
  "schedule_id": "1"
}

Response

idstring

Planning version identifier

effective_atstring required

Planning version start date

planning_toolstring required

Type of planning tool (shift_management, work_schedules, contract_hours)

number_of_rest_days_in_centsinteger

Amount of rest days per week if applicable (in cents)

employee_idstring required

Employee identifier

work_schedule_schedule_idstring

Work schedule identifier to include if applicable

Example response

{
  "id": "1",
  "effective_at": "2020-09-07",
  "planning_tool": "shift_management",
  "number_of_rest_days_in_cents": 200,
  "employee_id": "1",
  "work_schedule_schedule_id": "1"
}