Compatibility REST APIQueues

Update a Queue

View as Markdown
Modify the properties of a call queue. Queue names must be unique among active queues within an account. Deleted queue names can be reused. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

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

Request

This endpoint expects an object.
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

The request has succeeded.
sidstringformat: "uuid"
The unique identifier for the queue.
account_sidstringformat: "uuid"
The unique identifier for the account this Queue is associated with.
friendly_namestring
A description that distinguishes a queue.
max_sizeinteger or null
The maximum number of calls that are allowed to wait in a queue. Null if no limit is set.
current_sizeinteger>=0
The number of calls currently waiting in the queue.
average_wait_timeinteger>=0
The average wait time, in seconds, of callers in a queue.
date_createdstring
The date and time, in RFC 2822 format, the Queue was created.
date_updatedstring
The date and time, in RFC 2822 format, the Queue was updated.
api_versionstring
The version of the SignalWire API.
uristring
The URI of this resource, relative to the API base URL.

Errors