Update queue

PUT

https://{your_space_name}.signalwire.com/api/relay/rest/queues/:id

Changes how a project voice queue is identified or how many callers it can hold. A new name must remain unique among the project’s active queues. Queue-member positions and wait times are read through the Queue Members endpoints. The Compatibility API updates the same queues through its SID-based route.

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.

Changes how a project voice queue is identified or how many callers it can hold. A new name must remain unique among the project's active queues. Queue-member positions and wait times are read through the Queue Members endpoints. The Compatibility API updates the same queues through its SID-based route. #### 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)

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

idstringRequiredformat: "uuid"

Unique ID of the queue.

Request

This endpoint expects an object.

namestringOptional

The name of the queue.

max_sizeintegerOptional

The maximum number of callers allowed in the queue.

Response

The request has succeeded.

idstringformat: "uuid"

The unique identifier of the queue.

project_idstringformat: "uuid"

The project ID associated with this queue.

friendly_namestring

The friendly name of the queue.

max_sizeintegerOptional

The maximum number of callers allowed in the queue.

current_sizeintegerOptional

The current number of callers in the queue.

average_wait_timeintegerOptional

The average wait time in seconds.

uristringOptional

The URL of this queue.

date_createddatetimeOptional

Timestamp when the queue was created.

date_updateddatetimeOptional

Timestamp when the queue was last updated.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X PUT https://{your_space_name}.signalwire.com/api/relay/rest/queues/id \
>	-H "Content-Type: application/json" \
>	-u "<project_id>:<api_token>" \
>	-d '{}'

1	{
2	"id": "aae131db-214c-46f5-88b6-92004f8467cf",
3	"project_id": "c6c4679b-716a-456a-9e41-a03821005005",
4	"friendly_name": "test",
5	"max_size": 5,
6	"current_size": 0,
7	"average_wait_time": 0,
8	"uri": "/api/relay/rest/queues/aae131db-214c-46f5-88b6-92004f8467cf",
9	"date_created": "2024-01-15T09:30:00Z",
10	"date_updated": "2024-01-15T09:30:00Z"
11	}