JSON API » customs » customs/set

Sets the value of a custom setting.

Input parameters

Requires authentication and the commerce role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name of custom setting.	Yes
plan	Integer	ID of rate plan.	Yes
language	String	Language code.	No	Default language.
max_level	Integer	Maximum customer depth. -1 for unlimited.	No	-1
min_level	Integer	Minimum customer depth.	No	0
value	String	The value to set.	No	0
validation	Integer	1 to validate input then return, 0 for full action.	No	0

To set for all customers recursively, do not specify min_level or max_level. To set for direct customers, specify min_level=1 and max_level=1.

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.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/customs/set/?auth_username=user;auth_password=password;name=footer_text;plan=2;value=Test+footer+text

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

Change history

Version	Changes
3.13	Function added.