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-a4b2-472d-a123-231fe640755b",
  "edit_date": "2025-08-01 12:00:00",
  "job_uuid": "123e4567-67a3-41e0-8643-231fe9edfb0b",
  "queue_uuid": "123e4567-502e-4a9a-89e9-231fe3423ddb",
  "staff_uuid": "123e4567-0982-463c-a12e-231feadd72ab",
  "allocation_date": "2025-08-01 12:00:00",
  "allocation_window_uuid": "123e4567-e0a6-4e63-84e3-231fe31716bb",
  "allocated_by_staff_uuid": "123e4567-87bf-4114-ab63-231fe4cca40b",
  "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