Create or update an app setting value

POST

/app-setting-values

Sets the value of a named app setting for an entity or one of its accounts. This operation is an upsert — if a value for the given setting name already exists on the target component, it is updated in place; otherwise a new record is created. The setting must exist in the system and must not be admin-only. The caller must have the appropriate ACL permission (can_set_setting_values for entity-scoped settings, can_set_account_setting_values for account-scoped settings). The type and shape of value are validated against the setting's configured constraints at write time.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The setting value was created or updated successfully. The full setting value record is returned.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

cURL

Set an entity-level settingSet an account-level settingSet a boolean flag setting

curl --location '/app-setting-values' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "max_daily_transfer_limit",
    "value": 500000
}'

Response Example

200 - Entity-level setting set

{
    "message": "App setting value set successfully",
    "status": "success",
    "data": {
        "id": "01HQZR2BKPFQ8MXJVT3G7LWN5",
        "name": "max_daily_transfer_limit",
        "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "component_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "component_type": "entity",
        "value": 500000,
        "identity_id": "01HQZR2BKPFQ8MXJVT3G7LWNB",
        "created": 1754524800000,
        "updated": 1754524800000
    }
}

Modified at 2026-08-06 16:06:15

List app setting values

Create an entity