Sign in
Job Allocations

Create a new Job Allocation

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/joballocation.json

Request body

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

job_uuidstring uuid
queue_uuidstring uuid
staff_uuidstring uuid
allocation_datestring
allocation_window_uuidstring uuid
allocated_by_staff_uuidstring uuid
allocated_timestampstring
expiry_timestampstring
read_timestampstring
completion_timestampstring
estimated_durationstring
revised_durationstring
sort_prioritystring
requires_acceptancestring
acceptance_statusstring
acceptance_timestampstring

Example request

{
  "uuid": "123e4567-ada3-4826-9e93-230fe287e58b",
  "edit_date": "2025-07-01 12:00:00",
  "job_uuid": "123e4567-f7ce-4af4-b139-230fe2c16f4b",
  "queue_uuid": "123e4567-e232-413b-a159-230fe281098b",
  "staff_uuid": "123e4567-bd37-4c23-be2a-230fefa81ccb",
  "allocation_date": "2025-07-01 12:00:00",
  "allocation_window_uuid": "123e4567-e1be-414b-8c19-230fe736d52b",
  "allocated_by_staff_uuid": "123e4567-06af-4be2-8621-230fe2981abb",
  "allocated_timestamp": "2025-07-01 12:00:00",
  "expiry_timestamp": "2025-07-01 12:00:00",
  "read_timestamp": "2025-07-01 12:00:00",
  "completion_timestamp": "2025-07-01 12:00:00",
  "acceptance_timestamp": "2025-07-01 12:00:00"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes