JSON API » patternmenus » patternmenus/update

Updates an existing pattern menu.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of pattern menu to update.	Yes
description	String	Description.	No	Current value.
maximum_digits	Integer	Maximum number of digits to collect from caller.	No	Current value.
name	String	Name.	No	Current value.
owner	Integer	ID of owner. 0 for none.	No	Current value.
panel	Integer	1 to show in control panel, 0 not to.	No	Current value.
timeout	Integer	Timeout in seconds. -1 for no limit.	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 pattern menu 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/patternmenus/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.