JSON API » classes » classes/update

Updates an existing number class.

Input parameters

Requires authentication and the system role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of number class to update.	Yes
callerid_location	Integer	1 to allow customers to use as location callerid, 0 not to.	No	Current value.
customer	Integer	ID of customer to assign to. 0 for none.	No	Current value.
description	String	Description.	No	Current value.
name	String	Name.	No	Current value.
ported	Integer	1 to put ported numbers in this class, 0 not to.	No	Current value.
rank	Integer	1 to 10.	No	Current value.
transaction_text_create	String	Text to show on transactions for creation.	No	Current value.
transaction_text_period	String	Text to show on transactions each billing period.	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.
404	The number class does not exist.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/classes/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.