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-9584-4235-8890-231ef127f94b",
  "edit_date": "2025-08-01 12:00:00",
  "job_uuid": "123e4567-de2e-42c6-900b-231ef65dc64b",
  "queue_uuid": "123e4567-6d6b-4396-b5e1-231effea8afb",
  "staff_uuid": "123e4567-a6f1-4198-9905-231efe66979b",
  "allocation_date": "2025-08-01 12:00:00",
  "allocation_window_uuid": "123e4567-12a7-4e6c-8591-231ef2c33fdb",
  "allocated_by_staff_uuid": "123e4567-db03-4899-9c06-231ef4f5a41b",
  "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