Job Queues

Update a Job Queue

OAuth Scope

This endpoint requires the following OAuth scope manage_job_queues.

post/queue/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Job Queue

Request body

uuidstring uuid

Unique identifier for this record

namestring

Name of the job queue. Used to identify the queue in the system. Examples include 'Workshop', 'Pending Quotes', etc.

default_timeframeinteger

Default number of days that jobs should remain in this queue before requiring attention. Common values are 7 days (1 week) or 14 days (2 weeks).

subscribed_staffstring

Semicolon-delimited list of staff UUIDs who are subscribed to receive notifications for this queue.

requires_assignment0 | 1

Determines if jobs in this queue require assignment to staff members. If true, jobs must be explicitly assigned to staff. If false, jobs are visible to all staff.. Valid values are [0,1]

Example request

{
  "uuid": "123e4567-71e5-45f7-b2e4-23f94dc2684b"
}

Response

Success - The record was updated successfully

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

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

    • removed the request property active

      request-property-removed

    • 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