PUT - Update a queue

Purpose

Use this API to update a queue.

Authorization

HeaderKey	Description
Authorization*	Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept*	Set to application/json.

Scope

*All APIs are accessible under zohovoice.queues.ALL scope.

OAuth Doc

Request URL

Method: PUT

https://voice.zoho.com/rest/json/zv/api/groups

Scope: zohovoice.queues.UPDATE

Parameters:

Param Name

Data Type

Description

data *

JSONObject

Represents the queue data in JSON format.

The name, members, isBulk, config, groupid keys are mandatory.

Example:

{
"name": "Sales Queue",
"emailId": "queue1@zoho.com",
"qapId": "2069000002486021",
"members": [
"2069000000005011",
"2069000000044027"
],
"emailNotificationConfig": "1",
"queueWaitMusic": {
"mode": "audio",
"audioId": "",
"enableDefaultAnnouncements": false
},
"isBulk": false,
"extension": "9999",
"config": {
"max-wait-time": 60,
"max-wait-time-with-no-agent": 60,
"strategy": "top-down",
"mwtformat": "seconds",
"mwtwnaformat": "seconds"
},
"autoCallBackRequest": {
"callBackType": "1",
"callBackInterval": 15,
"callBackTryCount": 3,
"callBackExpiryTime": 1
},
"groupid": "2069000000250017"
}

agentChanged

Boolean

Represents whether the order of values in the members list has changed. Set to true if the order is updated.

Data JSON:

Key	Data Type	Description
members*	JSONArray of Long	Represents the list of agent IDs. Example: [AGENT_ID1, AGENT_ID2]
extension	Integer	Represents the extension number. Maximum four digits allowed.
emailNotificationConfig	Integer	Represents the email notification configuration. Possible values: 0 - Do not notify 1 - All missed calls 2 - Missed calls with voicemail 3 - All calls
name*	String	Represents the name of the queue
emailId	String	Represents the email ID that receives queue missed call notifications.
queueWaitMusic	JSONObject	Represents the queue wait music configuration. Example: { "audioId": "", "enableDefaultAnnouncements": true }
qapId	Long	Represents the queue audio profile ID.
isBulk*	Boolean	Represents whether agents are added in bulk. Default value is false.
config*	JSONObject	Represents the queue configuration. Example: { "mwtformat": "seconds", "mwtwnaformat": "seconds", "max-wait-time-with-no-agent": 60, "max-wait-time": 60, "strategy": "top-down" } strategy possible values: top-down ring-progressively round-robin ring-all
autocallBack	JSONObject	Represents the callback request configuration. Example: { "callBackTryCount": 3, "callBackInterval": 15, "callBackExpiryTime": 1, "callBackType": "1" }
groupid	Long	Represents the unique ID of the queue.

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/api/groups" \
-X PUT \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "code":"200",
  "groupId":4061000001205001,
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
  "code": "<App Error Code>",
  "message": "<Error Message>",
  "status": "ERROR"
}