Update Queue

patch

https://api.regal.ai/v1/queues/{id}

API Details

Partially updates a queue. Omitted fields are left unchanged. eligibilityExpression and includeAiAgents share one eligibility expression — providing only one keeps the queue's current value for the other. System-created queues (brand defaults such as Everyone) cannot be renamed.

Rate Limit

Limit Type	Value
Requests per second	10

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Path Params

string

required

Unique identifier of the queue.

Body Params

Request body for partially updating an existing queue. The queue id is taken from the path.

name

string

length ≥ 1

Display name of the queue.

taskOrder

string

enum

Task ordering strategy for this queue. FIFO = tasks sorted by priority, highest priority assigned first. LIFO = most recent task assigned first.

Allowed:

maxReservedAgents

integer

≥ 1

Maximum number of agents that can be reserved from this queue simultaneously. Should generally be 1 for queues containing auto-accepted tasks (e.g. auto-accepted inbound calls, transfers, power dial, or progressive dial) -- reserving multiple agents can create a confusing experience where one agent accepts while others' reservations are rescinded.

transferEligible

boolean

Whether this queue appears in the internal transfer list (a manual transfer destination in the agent desktop). Setting this to false hides it from that list without affecting routing eligibility.

description

string

Optional description of the queue's purpose.

eligibilityExpression

string

length ≥ 1

Twilio TaskRouter worker eligibility expression that decides which agents are eligible for this queue, e.g. "email == '[email protected]'". Queue eligibility expressions are worker-scoped: reference worker attributes directly (e.g. email, teams), not prefixed with worker. -- that prefix is used in routing-rule agent expressions, not queue eligibility expressions.

includeAiAgents

boolean

Whether AI agents are eligible for tasks in this queue. Must be explicitly set to true for AI agents to be eligible, even if the eligibility expression would otherwise match them.

sla

object

Service level agreement target: the expected maximum time for tasks in this queue to be accepted, broken down into time components.

Responses

200The updated queue

400Invalid queue id or request body.

403The API key is not a brand admin.

404Queue not found.

409Queue is a system-created default and cannot be renamed.

429Exceeded rate limit.