JSON API » huntgroups » huntgroups/destinations/update

Updates an existing hunt group destination.

Input parameters

Requires authentication and the residential or user role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of hunt group destination to update.	Yes
append_callerid	String	Digits to append to callerid.	No	Current value.
available	Integer	1 if destination is available, 0 if not.	No	Current value.
dtype	String	Destination type. "forward", "peer", "phone", or "sipuri".	No	Current value.
dnumber	String	Destination number.	No	Current value.
level	Integer	Level from 1 to 10.	No	Current value.
screen	Integer	1 to play the callerid, 0 not to screen.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0
description	String	Destination description.	No

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.
404	The hunt group or destination does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the level

http://enswitch.example.com/api/json/huntgroups/destinations/update/?auth_username=user;auth_password=password;id=123;level=1

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.2	description parameter added.
3.13	Function added.