JSON API » prefixes » prefixes/update

Updates an existing feature prefix.

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
id	Integer	ID of feature prefix to update.	Yes
called_minimum	Integer	Minimum length of called number to match.	No	Current value.
called_maximum	Integer	Maximum length of called number to match.	No	Current value.
description	String	Description.	No	Current value.
dtype	String	Destination type.	No	Current value.
dnumber	String	Destination number.	No	Current value.
pin	String	PIN to use. Empty string for none.	No	Current value.
prefix	String	Called number prefix.	No	Current value.
shared	Integer	1 to share with all customers on system, 0 not to.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

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

Data returned

No data is returned.

Example: Changing the prefix

http://enswitch.example.com/api/json/prefixes/update/?auth_username=user;auth_password=password;id=123;prefix=100

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

Change history

Version	Changes
3.13	Function added.