Skip to main content
PATCH
Update Queue Settings

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Queue ID

Pattern: ^[1-9]\d*$

Body

application/json
callback
boolean
callbackCallerIdNumber
string
Pattern: ^[1-9]\d{9}$
callbackMaxAttempts
number
Required range: 1 <= x <= 5
exitKey
enum<string>
Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
*,
#,
IVR
ivrId
number
exitKeyDestinations
object[]
playToCaller
enum<string> | null
Available options:
,
r,
R
periodicAnnounceFrequency
Required range: x > 0
reportHoldTime
boolean
announceHoldTime
enum<string>
Available options:
yes,
no,
once
announcePosition
enum<string>
Available options:
yes,
no,
limit,
more
announcePositionLimit
number
Required range: x >= 0
announceFrequency
number
Required range: x >= 0
mediaDestinations
object[]
ringInUse
boolean
autoPause
boolean
autoFill
boolean
ringAgentsOnlyOnce
boolean
agentTimeout
number
agentWrapupTime
number
Required range: x >= 0
tierTimeout
Available options:
15
enableAgentDestinations
boolean
default:false
allowedAgents
object[]

Response

200 - application/json

Updated 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