Setting

Represents configuration settings. Settings are quite versatile. These can be used in feature toggles or rules to accomplish insane variety of functions.

USAGE
Use a unique combination of context and contextId to create settings for various contexts. Not using a unique combination of those two will result in a ConstraintViolationException.

NOTE
If you are an existing client, you may already be using our Configuration Settings feature. You can still use this API to create new settings and update existing ones. However, we advise you to be very cautious in doing so as V4 APIs may behave unexpectedly if you modify your existing settings. If you have questions, please contact support.

Fields

id (ID!)

ID of the object

name (String)

Name of the setting.

valueType (String)

Data type of the setting's value. Supported types are LOB, STRING, INTEGER, BOOLEAN and JSON.

lobValue (Json)

Value of the setting. Use this if the value is a JSON.

value (String)

Value of the setting. Use this if the value is NOT a JSON.

context (String!)

The context of the setting. Supported values are ACCOUNT, RETAILER, AGENT or CUSTOMER

contextId (Int!)

ID of the context. For instance, use a retailer's ID when using RETAILER context.