Skip to main content
PATCH
Update field

Authorizations

Authorization
string
header
required

Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.

Path Parameters

objectName
string
required
fieldName
string
required

Body

application/json
name
string

Rename the field.

description
string
required
boolean
enumValues
string[]

Full replacement of options.

enumColors
string[]
enumMultiple
boolean
indexed
boolean
enrichment
object

Enrichment binding that lets the field auto-fill from a provider.

clearEnrichment
boolean
calculation
object

Replace an existing calculation's metric/source. Stored fields cannot be converted; create a new column instead.

clearCalculation
boolean

Explicitly remove an existing calculation, leaving an editable boolean. Does not snapshot calculated values. Mutually exclusive with calculation.

Response

Successful response

ok
boolean
required