JSON API » urls » urls/update

Updates an existing web URL.

Input parameters

Requires authentication and the urls role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of web URL to update.	Yes
answer	String	URL to inform on answer. Empty string for none.	No	Current value.
description	String	Description.	No	Current value.
dtype	String	Destination type on no reply or error from web server.	No	Current value.
dnumber	String	Destination number on no reply or error from web server.	No	Current value.
hangup	String	URL to inform on hangup. Empty string for none.	No	Current value.
name	String	Name.	No	Current value.
route	String	URL to ask how to route the call.	No	Current value.
timeout	Integer	Timeout in seconds accessing URLs.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

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 web URL does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/urls/update/?auth_username=user;auth_password=password;id=123;name=example

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

Change history

Version	Changes
3.13	Function added.