Job Allocations

Create a new Job Allocation

Changed on

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

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/joballocation.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: manage_schedule

Request body

job_uuidstring uuid

The UUID of the job that this allocation relates to.

queue_uuidunknown
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.

estimated_durationunknown
revised_durationunknown
sort_prioritystring

The sort priority for displaying this job allocation.

requires_acceptanceunknown
acceptance_statusunknown
acceptance_timestampunknown
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

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

  • 638a8df09bf4Revision changes
    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type, and format from uuid to no format

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • warning

      removed the request property

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status