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-d518-405e-b205-231b273ee2ab",
  "edit_date": "2025-08-01 12:00:00",
  "job_uuid": "123e4567-e9a5-4f57-9b2c-231b21d2b61b",
  "queue_uuid": "123e4567-2b70-4dfd-97be-231b2083d97b",
  "staff_uuid": "123e4567-2edf-4eea-963f-231b2ba6039b",
  "allocation_date": "2025-08-01 12:00:00",
  "allocation_window_uuid": "123e4567-15a0-4e95-a20b-231b2fbff81b",
  "allocated_by_staff_uuid": "123e4567-fd2f-46cb-aafd-231b2a591b4b",
  "allocated_timestamp": "2025-08-01 12:00:00",
  "expiry_timestamp": "2025-08-01 12:00:00",
  "read_timestamp": "2025-08-01 12:00:00",
  "completion_timestamp": "2025-08-01 12:00:00",
  "acceptance_timestamp": "2025-08-01 12:00:00"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes