For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
        • Accounts
        • Applications
        • Calls
        • Conferences
        • Faxes
        • LAML Bins
        • Messages
        • Phone Numbers
        • Queues
          • create
          • delete
          • dequeueMember
          • get
          • getMember
          • list
          • listMembers
          • update
        • Recordings
        • Tokens
        • Transcriptions
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientCompatQueues

update

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

Recordings

Next
Built with

Update a queue’s configuration. Uses POST (Twilio convention).

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account this Queue is associated with.
SidstringRequiredformat: "uuid"
The unique identifier for the queue.

Request

FriendlyNamestringRequiredformat: "^\w+$">=1 character
A unique name for the queue. Must contain only alphanumeric characters and underscores.
MaxSizeintegerOptional
The maximum number of calls that are allowed to wait in a queue. Must be a positive integer.

Response

sidstringRequiredformat: "uuid"
The unique identifier for the queue.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account this Queue is associated with.
friendly_namestringRequired
A description that distinguishes a queue.
max_sizeinteger or nullRequired
The maximum number of calls that are allowed to wait in a queue. Null if no limit is set.
current_sizeintegerRequired>=0
The number of calls currently waiting in the queue.
average_wait_timeintegerRequired>=0
The average wait time, in seconds, of callers in a queue.
date_createdstringRequired
The date and time, in RFC 2822 format, the Queue was created.
date_updatedstringRequired
The date and time, in RFC 2822 format, the Queue was updated.
api_versionstringRequired
The version of the SignalWire API.
uristringRequired
The URI of this resource, relative to the API base URL.

Response Example

Response
1{
2  "sid": "b3877c40-da60-4998-90ad-b792e98472qu",
3  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
4  "friendly_name": "Queue1",
5  "max_size": 100,
6  "current_size": 0,
7  "average_wait_time": 0,
8  "date_created": "Wed, 26 Sep 2018 18:00:00 +0000",
9  "date_updated": "Thu, 27 Sep 2018 19:00:00 +0000",
10  "api_version": "2010-04-01",
11  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu.json"
12}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9await client.compat.queues.update("QU...", { FriendlyName: "Support Queue", MaxSize: 200 });