Set Organisation Configuration

Time	Status	User Agent
Retrieving recent requests…

Use this API to set organisation configuration values. Specify the configuration key name, the value to assign, and the scope at which it applies — such as organisation, store, or zone level. For example, setting CONF_MAX_CARDS_PER_ORG controls the maximum number of active cards a customer can hold.

Note: For detailed information about the APIs and for hands-on testing, refer to the API overview and the guide on making your first API call.

Prerequisites

Basic Authentication
Default access group

Example request

curl --location 'https://eu.api.capillarytech.com/v2/organization/configs?format=json' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Basic <base64_encoded_credentials>' \
--data '{
  "keyName": "CONF_MAX_CARDS_PER_ORG",
  "value": "40",
  "scope": "ORG"
}'

Body parameters

Field	Type	Required	Description
`keyName`	string	Required	The name of the configuration key to set. For example, `CONF_MAX_CARDS_PER_ORG` sets the maximum number of active cards a customer can hold.
`value`	string	Required	The value to assign to the configuration key.
`scope`	enum	Required	The scope at which the configuration applies. Supported values: `ORG`, `OU`, `ZONE`, `STORE`, `STR_SERVER`, `TILL`, `RULE`. Case-sensitive.

Example response

{
    "id": 7417580,
    "entityId": 100737,
    "keyName": "CONF_MAX_CARDS_PER_ORG",
    "value": "40",
    "warnings": []
}

{
    "warnings": [],
    "errors": [
        {
            "status": false,
            "message": "All requests have failed due to errors",
            "code": 500
        }
    ]
}

Response parameters

Field	Type	Description
`id`	integer	Unique identifier for the configuration record.
`entityId`	integer	Identifier of the entity to which the configuration applies.
`keyName`	string	The configuration key that was set.
`value`	string	The value assigned to the configuration key.
`warnings`	array	List of warnings returned with the response. Empty if none.

Error & warning codes

Code	Error number	Type	Description
—	500	Error	Internal server error. The server encountered an unexpected condition. Retry after a short delay. HTTP 500.
—	3206	Error	Organisation configuration addition failure. The specified config key was not found. HTTP 400.