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-67d5-4193-b60d-231cfd47697b",
  "edit_date": "2025-08-01 12:00:00",
  "job_uuid": "123e4567-2fb3-45d5-bc89-231cf720673b",
  "queue_uuid": "123e4567-177b-41e0-9d64-231cfced911b",
  "staff_uuid": "123e4567-1fb5-47ed-a810-231cfa8889db",
  "allocation_date": "2025-08-01 12:00:00",
  "allocation_window_uuid": "123e4567-ef6d-4380-87a6-231cf592865b",
  "allocated_by_staff_uuid": "123e4567-bf47-45e7-a596-231cfc4a730b",
  "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