JSON API » patternmenus » patternmenus/create

Creates a new pattern menu.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name.	Yes
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
maximum_digits	Integer	Maximum number of digits to collect from caller.	No	100
owner	Integer	ID of owner. 0 for none.	No	0
panel	Integer	1 to show in control panel, 0 not to.	No	0
timeout	Integer	Timeout in seconds. -1 for no limit.	No	-1
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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.

Data returned

The ID of the created pattern menu.

Example: With required parameters

http://enswitch.example.com/api/json/patternmenus/create/?auth_username=user;auth_password=password;name=example

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
3.13	Function added.