JSON API » customs » customs/set

Sets the value of a custom setting.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringName of custom setting.Yes
planIntegerID of rate plan.Yes
languageStringLanguage code.NoDefault language.
max_levelIntegerMaximum customer depth. -1 for unlimited.No-1
min_levelIntegerMinimum customer depth.No0
valueStringThe value to set.No0
validationInteger1 to validate input then return, 0 for full action.No0

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

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your 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

VersionChanges
3.13Function added.