Update field metadata
Update a field’s metadata on a view. Omitted properties keep their current value.
Clearing metadata values
To clearlabel, description, groupLabel, format, aiContext, synonyms, or sampleValues, send null or an empty string ("").
drillFields works differently: null reverts the field to the view’s default drill fields, while an empty list ([]) or an empty string removes drill entirely.
Timeframe fields (for example, created_at[date]) and a composite topic’s shared fields can’t be cleared this way and will result in an error.Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The ID of the model.
"123e4567-e89b-12d3-a456-426614174000"
The name of the view that contains the field.
"orders"
The name of the field to update.
"total_amount"
Query Parameters
Branch ID to use for branch-aware operations
"123e4567-e89b-12d3-a456-426614174001"
Body
AI context for the field; null or an empty string clears it
Deprecated: use sampleValues instead. An array, or a comma-separated string; null or an empty string clears them.
Bin boundaries for binned fields; an array of numbers, or a comma-separated string
Labels for bins; an array, or a JSON-encoded array
Field description. Pass as null or an empty string to clear.
Drill-down fields as an array or a comma-separated string.
Pass an empty list or string to remove drilling, and null to revert to the view's default.
For grouped fields, values that don't match a group keep their original value instead of elseValue.
Else value for grouped fields
Filters for the field, keyed by filter ID.
Field format. Pass as null or an empty string to clear.
Group filters, one filter per entry in groupNames.
Group label. Pass as null or an empty string to clear.
Group names
Whether the field is hidden
Whether the field is ignored
Whether this is a calculation field
Field label. Pass as null or an empty string to clear.
New field name (for rename)
New view name (for move)
"orders"
Sample values for the field as an array or a comma-separated string. Pass as null or an empty string to clear.
SQL expression for the field
Synonyms for the field as an array or a comma-separated string. Pass as null or an empty string to clear.
Tags for the field as an array or a comma-separated string.
Topic context for the field
Response
Field updated successfully
true