Sign in
Allocation Windows

Create a new Allocation Window

OAuth Scope

This endpoint requires the following OAuth scope manage_schedule.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/allocationwindow.json

Request body

namestring

Name of the allocation window that defines a time period for job scheduling. Common examples include 'Morning', 'Afternoon', 'Business Hours', etc.

start_timeinteger

Start time of the allocation window measured in minutes from midnight. For example, 800 AM would be represented as 480 (8 hours × 60 minutes).

end_timeinteger

End time of the allocation window measured in minutes from midnight. For example, 1700 (500 PM) would be represented as 1020 (17 hours × 60 minutes).

sort_priorityinteger

Numeric value determining the display order of allocation windows. Lower values indicate higher priority. System automatically sets this to match the start_time in minutes, unless it's an urgent priority window which gets priority 0.

uuidstring uuid

Unique identifier for this record

Example request

{
  "uuid": "123e4567-9e55-4976-84a7-23eb28c6577b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes