v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Users
Capacity
Schedules

Create Capacity Schedule

Creates a new capacity schedule for a user or team profile at a specific location.

Exactly one of userID or profileID must be provided (mutually exclusive).

When rotationPatternEnabled is true, both rotationWeeksOn and rotationWeeksOff are required.

Capacity values are in minutes per day (0-1440). Time values use HH:MM or HH:MM:SS format.

post/v2/users/capacity/schedules

Request body

scheduleNamestring required

Name of the schedule.

startDatestring required

Start date (YYYY-MM-DD).

endDatestring

Optional end date (YYYY-MM-DD). Must be >= startDate.

locationIDinteger required

Location ID for the schedule.

userIDinteger

User ID to assign. Mutually exclusive with profileID.

profileIDinteger

Team profile ID to assign. Mutually exclusive with userID.

mondayCapacityinteger
tuesdayCapacityinteger
wednesdayCapacityinteger
thursdayCapacityinteger
fridayCapacityinteger
saturdayCapacityinteger
sundayCapacityinteger
mondayStartTimestring
mondayEndTimestring
tuesdayStartTimestring
tuesdayEndTimestring
wednesdayStartTimestring
wednesdayEndTimestring
thursdayStartTimestring
thursdayEndTimestring
fridayStartTimestring
fridayEndTimestring
saturdayStartTimestring
saturdayEndTimestring
sundayStartTimestring
sundayEndTimestring
rotationPatternEnabledboolean

Enable rotation pattern. When true, rotationWeeksOn and rotationWeeksOff are required.

rotationWeeksOninteger
rotationWeeksOffinteger
scheduleNotesstring
priorityinteger
isActiveboolean

Response

Created

scheduleIDinteger