Skip to Content
API ReferenceFieldPOST /update

POST /field/update

Update Field

Update fields using composable infra architecture.

Request Body (UpdateFieldApiRequest)

FieldTypeRequiredDescription
fieldsUpdateFieldItem[]NoList of fields to update (required on first call when all is false)
allbooleanNoWhen true, apply patch to every field matching the filter fields below (minus excluded_ids)
excluded_idsstring[]NoUUIDs to skip even when matched by all-mode filters
patchUpdateFieldPatchNoShared change set applied to every matched row when all=true (sparse — only set fields are updated; patch.id ignored)
searchstringNoFull-text search query
parameter_idsstring[]NoFilter by parameter UUIDs
persona_idsstring[]NoFilter by persona UUIDs
filter_department_idsstring[]NoFilter by department UUIDs
parameter_searchstringNoSearch text for parameter facet (no-op for row filtering)
persona_searchstringNoSearch text for persona facet (no-op for row filtering)
department_searchstringNoSearch text for department facet (no-op for row filtering)
flag_searchstringNoSearch text for flag 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 (UpdateFieldApiResponse)

FieldTypeRequiredDescription
resultsFieldResultItem[]YesPer-item update results
idempotency_keystringNoIdempotency key echoed back for client correlation
Last updated on