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

# Update field

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

## Path parameters

- `modelId` string, uuid, required — Model UUID
- `viewName` string, required — View name
- `fieldName` string, required — Field name

## Query parameters

- `branch_id` string, uuid — Branch ID to use for branch-aware operations

## Request body

- ModelsUpdateFieldBody
  - `aiContext` string — AI context for the field
  - `allValues` string[] — Deprecated: use sampleValues instead
  - `binBoundaries` number[] — Bin boundaries for binned fields
  - `binLabels` string[] — Labels for bins
  - `description` string — Field description
  - `drillFields` string[] — Drill-down fields
  - `elseValue` string — Else value for grouped fields
  - `filters` object — Filters for the field, keyed by filter id
  - `format` string — Field format
  - `groupFilters` object[] — Group filters, one filter per entry in groupNames
    - `type` 'string' | 'number' | 'date' | 'boolean' | 'null' | 'composite' | 'query' | 'user_attribute', required
  - `groupLabel` string — Group label
  - `groupNames` string[] — Group names
  - `hidden` boolean — Whether the field is hidden
  - `ignored` boolean — Whether the field is ignored
  - `isCalc` boolean — Whether this is a calculation field
  - `label` string — Field label
  - `newFieldName` string — New field name (for rename)
  - `newViewName` string — New view name (for move)
  - `sampleValues` string[] — Sample values for the field
  - `sql` string — SQL expression for the field
  - `synonyms` string[] — Synonyms for the field
  - `tags` string[] — Tags for the field
  - `topicContext` string — Topic context for the field

## Response `200`

Field updated successfully

- SuccessResponse
  - `success` boolean, required — Whether the operation was successful

## Other responses

- `400` — Invalid request body
- `401` — Authentication required
- `403` — Permission denied
- `404` — Model, view, or field not found

## Changes

> 22 revisions in range; 14 could not be searched.

- **2026-08-04** `d84b70fbd0ef` — 3 breaking
  - added the new required request property `filters/additionalProperties/type`
  - added the new required request property `groupFilters/items/type`
  - the `filters/additionalProperties/` request property type/format changed from ``/`` to `object`/``

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

---

[API](https://skmtc.dev/omniapp/apis/omni-api.md) · [All operations](https://skmtc.dev/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/omniapp/omni-api/revisions/2ed3f36eff42/schema)