Skip to main content
POST
Create Queue

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
number
required
Required string length: 2 - 9
Pattern: ^[0-9]*$
tenantId
number
required
timeout
number
required
nobodyHome
boolean
required
noFreeMember
boolean
required
notifyAbandoned
boolean
required
maxLength
number
required
Required range: x <= 50Must be a multiple of 5
ringStrategy
enum<string>
required
Available options:
RINGALL,
RRMEMORY,
RANDOM,
LINEAR,
FEWESTCALLS,
LEASTRECENT
branchId
number
recording
boolean
autoLogout
Available options:
0
agentPickup
Available options:
0
notifyAbandonedEmail
string<email>
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
timeoutDestinations
object[]
queueFullDestinations
object[]
noAvailableAgentsDestinations
object[]
allAgentsBusyDestinations
object[]

Response

200 - application/json

Created queue

id
number
required

Queue ID

name
string
required

Queue name

tenantId
number
required

Tenant ID

number
string | null

Queue number

branch
object | null

Owning branch

{key}
any