Sign in
Queues

Update a Queue

Changes how a voice queue is identified or how many callers it can hold. A new name must remain unique among the account's active queues. Use Queue Members operations to inspect or dequeue callers currently waiting.

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.

post/Accounts/{AccountSid}/Queues/{Sid}

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account this Queue is associated with.

Sidstring uuid required

Universal Unique Identifier.

The unique identifier for the queue.

Response

The request has succeeded.

sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

friendly_namestring required

A description that distinguishes a queue.

max_sizeinteger nullable required

The maximum number of calls that are allowed to wait in a queue. Null if no limit is set.

current_sizeinteger required

The number of calls currently waiting in the queue.

average_wait_timeinteger required

The average wait time, in seconds, of callers in a queue.

date_createdstring required

The date and time, in RFC 2822 format, the Queue was created.

date_updatedstring required

The date and time, in RFC 2822 format, the Queue was updated.

api_versionstring required

The version of the SignalWire API.

uristring required

The URI of this resource, relative to the API base URL.

Example response

{
  "friendly_name": "Queue1",
  "max_size": 100,
  "date_created": "Wed, 26 Sep 2018 18:00:00 +0000",
  "date_updated": "Thu, 27 Sep 2018 19:00:00 +0000",
  "api_version": "2010-04-01",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu.json"
}

Changes

Changed in 6 of the 40 revisions of this API.16224

  • 2916d5e3072e22See the full diff
    • ▲

      the account_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • ▲

      the sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • ○

      added uuid to the account_sid response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added uuid to the sid response property allOf list for the response status 200

      response-property-all-of-added

  • 5344c0c93a4c15See the full diff
    • ▲

      added 'unevaluatedProperties' constraint to the request body

      request-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 200

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 400

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 401

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 404

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 422

      response-body-unevaluated-properties-added

  • 2e516ba2383f11See the full diff
    • ▲

      response property max_size list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      the MaxSize request property's exclusiveMinimum was decreased from true to 0.00

      request-property-exclusive-min-decreased

  • d5fbaaddfa3e7212See the full diff
    • ▲

      the FriendlyName request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      added the pattern ^\w+$ to the request property FriendlyName

      request-property-pattern-added

    • ▲

      the MaxSize request property type/format changed from string/ to integer/int32

      request-property-type-changed

    • ▲

      the response property max_size became nullable for the status 200

      response-property-became-nullable

    • ▲

      the average_wait_time response's property type/format changed from string/ to integer/int32 for status 200

      response-property-type-changed

    • ▲

      the current_size response's property type/format changed from string/ to integer/int32 for status 200

      response-property-type-changed

    • ▲

      the max_size response's property type/format changed from string/ to integer/int32 for status 200

      response-property-type-changed

    • ●

      the MaxSize request property's exclusiveMinimum was set to true

      request-property-exclusive-min-set

    • ●

      the MaxSize request property's min was set to 0.00

      request-property-min-set

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 422

      response-non-success-status-added

    • ○

      the response property account_sid became required for the status 200

      response-property-became-required

    • ○

      the response property average_wait_time became required for the status 200

      response-property-became-required

    • ○

      the response property current_size became required for the status 200

      response-property-became-required

    • ○

      the response property date_created became required for the status 200

      response-property-became-required

    • ○

      the response property date_updated became required for the status 200

      response-property-became-required

    • ○

      the response property friendly_name became required for the status 200

      response-property-became-required

    • ○

      the response property max_size became required for the status 200

      response-property-became-required

    • ○

      the response property sid became required for the status 200

      response-property-became-required

    • ○

      the response property uri became required for the status 200

      response-property-became-required

    • ○

      added the required property api_version to the response with the 200 status

      response-required-property-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 07f73f74a61d11See the full diff
    • ▲

      removed the media type application/json from the request body

      request-body-media-type-removed

    • ○

      added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c88f14db21e43See the full diff
    • ▲

      added the new path request parameter AccountSid

      new-request-path-parameter

    • ▲

      added the new path request parameter Sid

      new-request-path-parameter

    • ▲

      removed the media type application/x-www-form-urlencoded from the request body

      request-body-media-type-removed

    • ▲

      the average_wait_time response's property type/format changed from string/uuid to string/ for status 200

      response-property-type-changed

    • ○

      added the media type application/json to the request body

      request-body-media-type-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog