---
title: "Update field metadata"
method: PATCH
path: "/v1/models/{modelId}/view/{viewName}/field/{fieldName}"
tags: ["Models"]
---

# Update field metadata

`PATCH /v1/models/{modelId}/view/{viewName}/field/{fieldName}`

## Request

- Base URL: `https://blobsrus.omniapp.co/api`
- URL: `https://blobsrus.omniapp.co/api/v1/models/{modelId}/view/{viewName}/field/{fieldName}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Update a field's metadata on a view. Omitted properties keep their current value.

## Path parameters

- `modelId` string, uuid, required
- `viewName` string, required
- `fieldName` string, required

## Query parameters

- `branch_id` string, uuid

## Request body

- object
  - `aiContext` string: AI context for the field; null or an empty string clears it
  - `allValues` union: Deprecated: use `sampleValues` instead. An array, or a comma-separated string; null or an empty string clears them.
    - string[]
    - string
  - `binBoundaries` union: Bin boundaries for binned fields; an array of numbers, or a comma-separated string
    - number[]
    - string
  - `binLabels` union: Labels for bins; an array, or a JSON-encoded array
    - string[]
    - string
  - `description` string: Field description. Pass as `null` or an empty string to clear.
  - `drillFields` union: 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.
    - string[]
    - string
  - `elseRawValue` union: For grouped fields, values that don't match a group keep their original value instead of `elseValue`.
    - boolean
    - string
  - `elseValue` string: Else value for grouped fields
  - `filters` union: Filters for the field, keyed by filter ID.
    - object
    - string
  - `format` string: Field format. Pass as `null` or an empty string to clear.
  - `groupFilters` union: Group filters, one filter per entry in `groupNames`.
    - object
      - `type` 'string' | 'number' | 'date' | 'boolean' | 'null' | 'composite' | 'query' | 'user_attribute', required
    - string
    - union[]
      - union
        - object
          - `type` 'string' | 'number' | 'date' | 'boolean' | 'null' | 'composite' | 'query' | 'user_attribute', required
        - string
  - `groupLabel` string: Group label. Pass as `null` or an empty string to clear.
  - `groupNames` union: Group names
    - string
    - string[]
  - `hidden` union: Whether the field is hidden
    - string
    - boolean
  - `ignored` union: Whether the field is ignored
    - string
    - boolean
  - `isCalc` union: Whether this is a calculation field
    - string
    - boolean
  - `label` string: Field label. Pass as `null` or an empty string to clear.
  - `newFieldName` string: New field name (for rename)
  - `newViewName` string: New view name (for move)
  - `sampleValues` union: Sample values for the field as an array or a comma-separated string. Pass as `null` or an empty string to clear.
    - string[]
    - string
  - `sql` string: SQL expression for the field
  - `synonyms` union: Synonyms for the field as an array or a comma-separated string. Pass as `null` or an empty string to clear.
    - string[]
    - string
  - `tags` union: Tags for the field as an array or a comma-separated string.
    - string[]
    - string
  - `topicContext` string: Topic context for the field

## Response `200`

Field updated successfully

- SuccessResponse
  - `success` boolean

## Other responses

- `400`: Invalid request body. Common causes: - A malformed value for a property, such as `binLabels` or `binBoundaries` - `null` sent for a timeframe field (for example, `created_at[date]`) or a composite topic's shared field, which can't be cleared this way
- `401`: Authentication required
- `403`: Permission denied
- `404`: Model, view, or field not found

## Changes

- **2026-11-03** `43290040f88f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/omni/apis/omni-api/changes/v1/models/:modelId/view/:viewName/field/:fieldName/patch.md)

---

[API](https://skmtc.dev/omni/apis/omni-api.md) - [All operations](https://skmtc.dev/omni/apis/omni-api/llms.txt) - [OpenAPI document](https://skmtc.dev/omni/apis/omni-api/revisions/43290040f88f?raw)