{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/accounts/:account_id/queues/:queue_id","auth":"required","examples":{"codes":[{"language":"php","code":"<?php\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n$response = $client->put('accounts/123/queues/5', ['json' => [\n    \"name\" => \"standard\",\n    \"greeting\" => \"MECO\",\n    \"hold_music\" => \"Classic rock\",\n    \"max_hold_time\" => 600,\n    \"caller_id_type\" => \"calling_number\",\n    \"ring_time\" => 30,\n    \"members\" [\n        {\n            \"extension\": 123\n        },\n        {\n            \"phone_number\": \"+16197742565\"\n        },\n        {\n            \"extension\": 999\n        }\n    ]\n]]);"}]},"method":"put","params":[{"name":"account_id","type":"int","default":"","desc":"Account ID","required":false,"in":"path","ref":"","_id":"56f9c415338fbb2000ec3711"},{"name":"queue_id","type":"int","default":"","desc":"Queue ID","required":false,"in":"path","ref":"","_id":"56f9c415338fbb2000ec3710"},{"name":"name","type":"string","default":"","desc":"Name of queue","required":false,"in":"body","ref":"","_id":"5748b901cc54530e00dc4271"},{"name":"greeting","type":"object","default":"","desc":"Recording lookup object","required":false,"in":"body","ref":"","_id":"5748b901cc54530e00dc4270"},{"name":"hold_music","type":"object","default":"","desc":"Recording lookup object","required":false,"in":"body","ref":"","_id":"5748b901cc54530e00dc426f"},{"name":"max_hold_time","type":"int","default":"","desc":"Max seconds for hold","required":false,"in":"body","ref":"","_id":"5748b901cc54530e00dc426e"},{"name":"caller_id_type","type":"string","default":"","desc":"Type of caller id","required":false,"in":"body","ref":"","_id":"5748b901cc54530e00dc426d"},{"name":"ring_time","type":"int","default":"","desc":"Number of seconds to ring each member","required":false,"in":"body","ref":"","_id":"5748b901cc54530e00dc426c"},{"name":"members","type":"array_object","default":"","desc":"Extensions or phone numbers","required":false,"in":"body","ref":"","_id":"5748b901cc54530e00dc426b"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"id\": 5,\n    \"name\": \"standard\",\n    \"greeting\": {\n        \"id\": 2984,\n        \"name\": \"MECO\",\n    },\n    \"hold_music\": {\n        \"id\": 12,\n        \"name\": \"Classic rock\",\n    },\n    \"max_hold_time\": 15,\n    \"caller_id_type\": \"calling_number\",\n    \"ring_time\": 30,\n    \"members\": [\n        {\n            \"extension\": {\n                \"id\": 34,\n                \"name\": \"Fred\",\n                \"extension\": 123\n            }\n        },\n        {\n            \"phone_number\": \"+16197742565\"\n        },\n        {\n            \"extension\": {\n                \"id\": 38,\n                \"name\": \"Lobo\",\n                \"extension\": 999\n            }\n        }\n    ]\n}"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Replace Queue","type":"endpoint","slug":"replace-account-queue","excerpt":"Replace a queue. See [Account Queues](doc:account-queues) for more info on the properties.","body":"The Replace Queue service replaces the parameters of a queue.  For more on the input fields, see [Account Queues](doc:account-queues).","updates":[],"order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57624356653c2d2200fec7af","__v":1,"createdAt":"2016-05-27T21:20:59.596Z","githubsync":"","editedParams":true,"editedParams2":true,"user":"571fcfeea0acd42000af95be","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Account Queues","slug":"account-queue","order":23,"from_sync":false,"reference":true,"_id":"57624356653c2d2200fec7a7","__v":0,"version":"57624356653c2d2200fec79c","project":"55c8cff571d7580d0063a5e5","createdAt":"2016-05-16T21:10:28.598Z"},"parentDoc":null,"project":"55c8cff571d7580d0063a5e5","version":{"version":"4","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f","5ede526e75bc22005d0adecc"],"_id":"57624356653c2d2200fec79c","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","__v":23,"project":"55c8cff571d7580d0063a5e5"}}

putReplace Queue

Replace a queue. See [Account Queues](doc:account-queues) for more info on the properties.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID
queue_id:
integer
Queue ID

Body Params

name:
string
Name of queue
greeting:
object
Recording lookup object
hold_music:
object
Recording lookup object
max_hold_time:
integer
Max seconds for hold
caller_id_type:
string
Type of caller id
ring_time:
integer
Number of seconds to ring each member
members:
array of objects
Extensions or phone numbers

Examples


Result Format


Documentation

The Replace Queue service replaces the parameters of a queue. For more on the input fields, see [Account Queues](doc:account-queues).

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}