Skip to Content
API ReferenceFieldPOST /delete

POST /field/delete

Delete Field

Bulk delete fields — composable infra architecture.

Request Body (DeleteFieldApiRequest)

FieldTypeRequiredDescription
field_idsstring[]NoUUIDs of fields to delete (required on first call when all is false)
allbooleanNoWhen true, delete every field matching the filter fields below (minus excluded_ids)
excluded_idsstring[]NoUUIDs to skip even when matched by all-mode filters
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 — confirms or rejects a dormant delete
softbooleanNoStage the delete dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept (confirm deletion) or reject (restore). Only meaningful with idempotency_key

Response (DeleteFieldApiResponse)

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