Skip to main content
POST
Create queue

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

application/json
name
string
required

Name of the queue.

Maximum string length: 255
isAutoAssignmentEnabled
boolean
default:false

Auto-assignment of the queue.

workingHoursId
string

Working hours Id queue belongs to

externalId
string

Response

OK

id
string
read-only
name
string

Queue name.

Maximum string length: 255
enabledAgentsCount
integer<int32>
enabledRoutesCount
integer<int32>
createdAt
string<date-time>
read-only
updatedAt
string<date-time>
read-only
isAutoAssignmentEnabled
boolean
default:false

Queue Auto-assignment toggle.

autoAssignmentAlgorithm
enum<string>
default:LOAD_BALANCING

Queue Auto-assignment algorithm.

Available options:
LOAD_BALANCING,
ROUND_ROBIN,
PERFORMANCE_BASED,
LOAD_BALANCING,
ROUND_ROBIN,
PERFORMANCE_BASED
isAutoAssignmentOutsideOfWorkingHoursEnabled
boolean
default:false

Queue Auto-assignment Outside of Working hours toggle

stickyAgentTimeoutDays
integer<int64>

Number of days since last interaction with the customer.

isStickyAutoAssignmentEnabled
boolean

Auto-assignment according to last interaction with the customer.

workingHoursId
string

Working hours Id queue belongs to

isRestricted
boolean
default:false

Is queue restricted.

isPrivate
boolean
default:false

Is queue private.

deletedAt
string<date-time>
externalId
string