JSON API » fields » fields/allowed/update

Updates an existing custom field allowed value. Only used for custom fields with type "allowed".

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
field	Integer	ID of field.	Yes
value	String	Allowed value.	Yes
display	String	Value to display to users. Empty string for same as value.	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 custom field does not exist.

Data returned

No data is returned.

Example: Changing the displayed value

http://enswitch.example.com/api/json/fields/allowed/update/?auth_username=user;auth_password=password;field=1;value=example1;display=Example+1

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

Change history

Version	Changes
4.0	Function added.