Create a new queue

Creates a new queue with the specified name and configuration. The name field is required and must be unique within your organization.

Finding Your Customer Subdomain

Your subdomain is found in your Avaya Infinity portal URL and is required for all API calls.

Example: If your portal URL is:

https://core.avaya1234.ec.avayacloud.com/app/core-config-ui/

Your subdomain is: avaya1234

To use this API:

  1. Find your subdomain from your Infinity portal URL (as shown above)
  2. Get your Bearer token using the ADMIN_API_CONSUMER client credential (see Authentication below)
  3. In the API explorer on the right:
    • Click on {customerId} in the URL field and replace it with your actual subdomain
    • Paste your Bearer token in the Credentials section
    • Fill out the request body with at minimum a unique queue name

Authentication

This endpoint requires a valid OAuth 2.0 Bearer token. To get started, contact Avaya Support to request a client_id and client_secret provisioned with the ADMIN_API_CONSUMER scope.

Once you have your credentials, generate an access token and include it in the Authorization: Bearer <token> header of each request.

Important Notes

  • name is the only required field. All other fields are optional and can be updated later.
  • Queue names must be unique within your organization. Submitting a duplicate name returns a 422 with the message name must be unique.
  • The queueId returned in the response is the permanent identifier used in all subsequent API calls for this queue.

DOS Protection & Rate Limiting

  • This endpoint implements DOS protection and rate limiting.

Security Implementation Guidelines

  • Never expose your client_secret or Bearer token to client-side applications.
  • Implement proper error handling — avoid surfacing internal error details to end users.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a new queue. Only name is required.

string | null
required

The display name of the queue. Must be unique within your organization.

FolderId | null

The ID of the folder to assign this queue to. Optional.

configDetails
object | null

Advanced queue configuration. Contact Avaya Developer Support before use.

string | null
^\d+$

Queue extension number. Must contain only digits.

string | null
Defaults to UTC

Timezone for the queue. Defaults to UTC.

templates
object | null

Template configuration for the queue.

actions
object | null

Action mappings for the queue.

string | null

ID of the scorecard associated with this queue. Must be provided together with scoreCardVersionId.

string | null

Version ID of the scorecard. Must be provided together with scoreCardId.

integer | null
≥ 0

Weight used for queue prioritization. Higher values indicate higher priority.

string | null
enum

Method used to route interactions to agents. leastRecent routes to the agent who has been idle longest, ringAll rings all available agents simultaneously, random selects an agent at random.

Allowed:
boolean
Defaults to true

When true, enables tag-based routing for this queue.

workflows
object | null

Workflow automation settings. Contact Avaya Developer Support before use.

reports
object | null

Reporting configuration for the queue.

boolean
Defaults to true

Whether the queue is active and available for routing. Set to false to deactivate without deleting.

boolean
Defaults to false

Performance metric flag. Contact Avaya Developer Support before use.

boolean
Defaults to false

When true, agents can modify the outbound caller ID for external transfers.

string | null
enum
Defaults to customer

Determines the caller ID presented on external transfers. customer uses the customer's number, queue uses the queue's number, custom uses the number specified in extXferCidNumber.

Allowed:
string | null
^\\+[1-9]\\d{1,14}$

Custom caller ID number for external transfers in E.164 format (e.g., +15551234567). Only used when extXferCidType is custom.

tagsToAdd
object | null

Tags to associate with this queue.

tagsToRemove
object | null

Tags to remove from this queue.

string | null
Defaults to US

Default country code used for phone number validation (e.g., US, GB).

boolean
Defaults to false

When true, validates the customer's phone number against the country specified in validateNumberCountry.

string | null

Path key for linked interactions. Contact Avaya Developer Support before use.

string | null

Speech-to-text plan ID. Contact Avaya Developer Support before use.

boolean

When true, allows phone interactions to be closed with an unresolved status.

string | null
enum

The default close status applied when an interaction is completed.

Allowed:
boolean

When true, agents must confirm before marking an interaction as resolved.

boolean

When true, automatically promotes a viewer to owner if the current owner leaves the interaction.

boolean

When true, the current owner can transfer ownership to a viewer.

boolean

When true, interactions are not automatically moved to completed status when the call ends.

boolean

When true, the owner can mute viewers in the interaction.

boolean

When true, the owner can remove viewers from the interaction.

boolean

When true, the owner can invite internal participants to the interaction.

boolean

When true, the owner can invite external participants to the interaction.

string | null

Elite skill routing address. Contact Avaya Developer Support before use.

string | null

Custom type classification for the queue (e.g., regular, personal).

string | null

Identifier of the user or system that last updated the queue. Read-only.

customDataDisplay
object | null

Custom data fields displayed in the queue UI. Contact Avaya Developer Support before use.

boolean
Defaults to false

When true, enables Agent Assist for this queue.

uuid | null

UUID of the AI Media Gateway Profile to use as the Agent Assist provider. Optional.

string | null

Optional workflow ID for custom Agent Assist event processing.

boolean | null

When true, displays a post-call modal to agents after a call ends.

boolean
Defaults to false

When true, the voice callback option is shown in the post-call modal.

boolean
Defaults to false

When true, the messaging option is shown in the post-call modal.

boolean
Defaults to false

When true, the email option is shown in the post-call modal.

boolean
Defaults to false

When true, the close-as-resolved option is shown in the post-call modal.

integer
5 to 300
Defaults to 10

Time in seconds before the post-call modal auto-dismisses. Must be between 5 and 300. Defaults to 10.

string
enum
Defaults to closeResolved

The default action pre-selected in the post-call modal. closeResolved marks the interaction resolved, email opens an email follow-up, voiceCallback schedules a callback, messaging opens a messaging follow-up.

Allowed:
boolean | null

When true, wrap-up is required before an agent can close a resolved interaction. When null, the queue uses the default behavior.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json