Skip to Content

POST /setting/update

Update Setting

Update settings using composable infra architecture.

Request Body (UpdateSettingApiRequest)

FieldTypeRequiredDescription
settingsUpdateSettingItem[]NoList of settings to update (required on first call when all is false)
allbooleanNoWhen true, apply patch to every setting matching the filter fields below (minus excluded_ids)
excluded_idsstring[]NoUUIDs to skip even when matched by all-mode filters
patchUpdateSettingPatchNoShared change set applied to every matched row when all=true (sparse — only set fields are updated; patch.id ignored)
searchstringNoFull-text search query
flag_idsstring[]NoFilter by flag UUIDs
provider_idsstring[]NoFilter by provider UUIDs
auth_idsstring[]NoFilter by auth UUIDs
system_idsstring[]NoFilter by system UUIDs
filter_department_idsstring[]NoFilter by department UUIDs
flag_searchstringNoSearch text for flag facet (no-op for row filtering)
provider_searchstringNoSearch text for provider facet (no-op for row filtering)
auth_searchstringNoSearch text for auth facet (no-op for row filtering)
system_searchstringNoSearch text for system facet (no-op for row filtering)
department_searchstringNoSearch text for department facet (no-op for row filtering)
idempotency_keystringNoOperation key for ack — promotes or rejects a dormant update
softbooleanNoStage the update dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept (promote) or reject dormant state. Only meaningful with idempotency_key

Response (UpdateSettingApiResponse)

FieldTypeRequiredDescription
resultsSettingResultItem[]YesPer-item update results
settingsListSettingApiSetting[]NoHydrated list rows for the updated settings. Mirrors the shape of /setting/search result rows so the client’s ghost rail can swap the live card without a refresh.
idempotency_keystringNoIdempotency key echoed back for client correlation
Last updated on