Sign in
Job Allocations

Update a Job Allocation

OAuth Scope

This endpoint requires the following OAuth scope manage_schedule.

post/joballocation/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Job Allocation

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-740c-4fa5-bf5e-23f94609a4bb",
  "staff_uuid": "123e4567-a785-42a0-a73f-23f948f854fb",
  "allocation_date": "2026-03-01 12:00:00",
  "allocation_window_uuid": "123e4567-6550-4c79-a464-23f946c4a94b",
  "allocated_by_staff_uuid": "123e4567-97e7-40aa-94e3-23f94ca2c33b",
  "allocated_timestamp": "2026-03-01 12:00:00",
  "expiry_timestamp": "2026-03-01 12:00:00",
  "read_timestamp": "2026-03-01 12:00:00",
  "completion_timestamp": "2026-03-01 12:00:00",
  "uuid": "123e4567-2d60-4e31-9315-23f94dd3f31b"
}

Response

Success - The record was updated successfully

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

Changed in 2 of the 50 revisions of this API.615

  • 638a8df09bf461See the full diff
    • ▲

      the acceptance_status request property type/format changed from string/ to /

      request-property-type-changed

    • ▲

      the acceptance_timestamp request property type/format changed from string/ to /

      request-property-type-changed

    • ▲

      the estimated_duration request property type/format changed from string/ to /

      request-property-type-changed

    • ▲

      the queue_uuid request property type/format changed from string/uuid to /

      request-property-type-changed

    • ▲

      the requires_acceptance request property type/format changed from string/ to /

      request-property-type-changed

    • ▲

      the revised_duration request property type/format changed from string/ to /

      request-property-type-changed

    • ●

      removed the request property active

      request-property-removed

  • ca9b053c43735See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added