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

job_uuidstring uuid

The UUID of the job that this allocation relates to.

{"stackTrail":"components:schemas:JobAllocationCreate:properties:queue_uuid","oasType":"schema","type":"unknown","description":"DEPRECATED"}
staff_uuidstring uuid

The UUID of the staff member this job is allocated to.

allocation_datestring

The minimum start date for a job allocation to be completed by a staff member. Setting this date will ensure the job allocation appears in the future on staff schedules.

allocation_window_uuidstring uuid

The UUID of the allocation window that defines when the job should be completed (e.g. Urgent, Early Morning, During Business Hours).

allocated_by_staff_uuidstring uuid

The UUID of the staff member who allocated the job.

allocated_timestampstring

The timestamp when the job was allocated.

expiry_timestampstring

The timestamp when the job allocation expires.

read_timestampstring

The timestamp when the job allocation was read by the staff member.

completion_timestampstring

The timestamp when the job allocation was marked as completed.

{"stackTrail":"components:schemas:JobAllocationCreate:properties:estimated_duration","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:JobAllocationCreate:properties:revised_duration","oasType":"schema","type":"unknown","description":"DEPRECATED"}
sort_prioritystring

The sort priority for displaying this job allocation.

{"stackTrail":"components:schemas:JobAllocationCreate:properties:requires_acceptance","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:JobAllocationCreate:properties:acceptance_status","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:JobAllocationCreate:properties:acceptance_timestamp","oasType":"schema","type":"unknown","description":"DEPRECATED"}
uuidstring uuid

Unique identifier for this record

Example request

{
  "job_uuid": "123e4567-b3d6-464b-ad2b-23482eb648fb",
  "staff_uuid": "123e4567-531a-45e8-9b26-23482037810b",
  "allocation_date": "2025-09-01 12:00:00",
  "allocation_window_uuid": "123e4567-662f-45ee-b4ee-23482143ad7b",
  "allocated_by_staff_uuid": "123e4567-6096-4405-b2ea-23482fad8e7b",
  "allocated_timestamp": "2025-09-01 12:00:00",
  "expiry_timestamp": "2025-09-01 12:00:00",
  "read_timestamp": "2025-09-01 12:00:00",
  "completion_timestamp": "2025-09-01 12:00:00",
  "uuid": "123e4567-a2c0-4206-9c5d-2348200e298b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes