Common
Update one or more setting values
Applies a batch of setting writes. Each item is checked against the caller's role/scope permission and the per-setting validation rules before being persisted as a single batch.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/common/settings/update" \ -H "Content-Type: application/json" \ -d '{ "settings": [ { "settingDefinitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "settingScopeId": "5a2e7b10-8c3e-4a1a-9e3a-1f2b3c4d5e6f", "scope": "account", "value": "5", "entityId": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } ] }'{ "result": { "data": "Success", "statusCode": 200, "message": "OK" }, "origin": "string", "dateTime": "string", "operationId": "string"}{ "error": { "innerErrors": [ { "code": "INVALID_LIMIT_VALUE", "message": "Limit value must be a non-negative integer or blank.", "userMessage": "Please provide a valid limit value." } ], "message": "Limit value must be a non-negative integer or blank.", "statusCode": 400 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "common-settings-update", "origin": ""}{ "error": { "innerErrors": [ { "code": "VALIDATION_ERROR", "message": "Name is required.", "userMessage": "Name is required." } ], "message": "One or more validation errors occurred.", "statusCode": 400 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "00-abc123-00", "origin": "self-service-portal"}{ "error": { "innerErrors": [ { "code": "UPDATE_SETTINGS_PERMISSION_DENIED", "message": "Caller is not permitted to update this setting.", "userMessage": "You do not have permission to update this setting." } ], "message": "Caller is not permitted to update this setting.", "statusCode": 403 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "common-settings-update", "origin": ""}{ "error": { "innerErrors": [ { "code": "SETTING_UPDATE_FAILED", "message": "Failed to persist one or more settings.", "userMessage": "Something went wrong. Please contact support." } ], "message": "Failed to persist one or more settings.", "statusCode": 500 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "common-settings-update", "origin": ""}