JSON API » provisioning » provisioning/update

Updates an existing provisioning template.

Input parameters

Requires authentication and the provisioning role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of provisioning template to update.	Yes
description	String	Description.	No	Current value.
lines_start	Integer	The number of the first line. 0, 1, or -1 for an absolute suffix.	No	Current value.
model	String	The model, or empty string for any.	No	Current value.
custom_name	String	Model name if provisioning a custom phone type.	No	Empty string.
name	String	Name.	No	Current value.
priority	Integer	Priority from 1 to 10.	No	Current value.
shared	Integer	1 to share with all customers on the system, 0 not to. Only has effect if system owner.	No	Current value.
speeddials_maximum	Integer	The maximum number of speed dials.	No	Current value.
speeddials_start	Integer	The number of the first speed dial.	No	Current value.
template1	String	The first, or only, provisioning template.	No	Current value..
template2	String	The second provisioning template if used.	No	Current value.
template_directory	String	The directory (speed dials) provisioning template if used.	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 provisioning template 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/provisioning/update/?auth_username=user;auth_password=password;id=123;name=example

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

Change history

Version	Changes
3.14	custom_name input parameter added.
3.13	Function added.