> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Update field metadata

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


## Clearing metadata values

To clear `label`, `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.


## OpenAPI

````yaml /api/openapi.yaml patch /v1/models/{modelId}/view/{viewName}/field/{fieldName}
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: Who Am I
    description: Inspect your own user permissions
  - name: AI
    description: AI-powered query generation
  - name: AI Credit Controls
    description: Manage organization-level AI credit usage
  - name: AI Credit Usage
    description: Monitor AI credit usage
  - name: AI Evals
    description: >-
      Manage prompt sets and runs used to score AI quality against curated
      prompt suites.
  - name: AI Model Suggestions
    description: Manage AI-generated suggestions for shared models
  - name: AI Routines
    description: >-
      Manage Routines, which are scheduled, recurring AI-powered tasks that run
      automatically on your data
  - name: Apps
    description: Draft and publish app documents.
  - name: App downloads
    description: Download apps as PNG, PDF, XLSX, or CSV files
  - name: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish.
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: IP Allowlist
    description: Manage the organization's IP allowlist
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Color Palettes
    description: Manage custom chart color palettes
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Embed
    description: Manage embed sessions
  - name: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content folders
  - name: Folder favorites
    description: Favorite and unfavorite folders
  - name: Folder labels
    description: Apply and manage labels on folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Skills
    description: >-
      Manage skills, the saved slash-command instructions the Omni AI assistant
      runs
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /v1/models/{modelId}/view/{viewName}/field/{fieldName}:
    patch:
      tags:
        - Models
      summary: Update field metadata
      description: >
        Update a field's metadata on a view. Omitted properties keep their
        current value.
      operationId: modelsUpdateField
      parameters:
        - $ref: '#/components/parameters/modelId'
        - name: viewName
          in: path
          required: true
          schema:
            type: string
            example: orders
          description: The name of the view that contains the field.
        - name: fieldName
          in: path
          required: true
          schema:
            type: string
            example: total_amount
          description: The name of the field to update.
        - $ref: '#/components/parameters/branchId'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                aiContext:
                  type: string
                  description: AI context for the field; null or an empty string clears it
                allValues:
                  anyOf:
                    - type: array
                      items:
                        type: string
                    - type: string
                    - type: 'null'
                  description: >
                    Deprecated: use `sampleValues` instead. An array, or a
                    comma-separated string; null or an empty string clears them.
                binBoundaries:
                  anyOf:
                    - type: array
                      items:
                        type: number
                    - type: string
                  description: >-
                    Bin boundaries for binned fields; an array of numbers, or a
                    comma-separated string
                binLabels:
                  anyOf:
                    - type: array
                      items:
                        type: string
                    - type: string
                  description: Labels for bins; an array, or a JSON-encoded array
                description:
                  type: string
                  description: >-
                    Field description. Pass as `null` or an empty string to
                    clear.
                drillFields:
                  anyOf:
                    - type: array
                      items:
                        type: string
                    - type: string
                    - type: 'null'
                  description: >
                    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.
                elseRawValue:
                  anyOf:
                    - type: boolean
                    - type: string
                  description: >
                    For grouped fields, values that don't match a group keep
                    their original value instead of `elseValue`.
                elseValue:
                  type: string
                  description: Else value for grouped fields
                filters:
                  anyOf:
                    - type: object
                      additionalProperties:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - string
                              - number
                              - date
                              - boolean
                              - 'null'
                              - composite
                              - query
                              - user_attribute
                        required:
                          - type
                        additionalProperties: {}
                    - type: string
                  description: Filters for the field, keyed by filter ID.
                format:
                  type: string
                  description: Field format. Pass as `null` or an empty string to clear.
                groupFilters:
                  anyOf:
                    - anyOf:
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - string
                                - number
                                - date
                                - boolean
                                - 'null'
                                - composite
                                - query
                                - user_attribute
                          required:
                            - type
                          additionalProperties: {}
                        - type: string
                    - type: array
                      items:
                        anyOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                enum:
                                  - string
                                  - number
                                  - date
                                  - boolean
                                  - 'null'
                                  - composite
                                  - query
                                  - user_attribute
                            required:
                              - type
                            additionalProperties: {}
                          - type: string
                  description: |
                    Group filters, one filter per entry in `groupNames`.
                groupLabel:
                  type: string
                  description: |
                    Group label. Pass as `null` or an empty string to clear.
                groupNames:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                  description: Group names
                hidden:
                  anyOf:
                    - type: string
                    - type: boolean
                  description: Whether the field is hidden
                ignored:
                  anyOf:
                    - type: string
                    - type: boolean
                  description: Whether the field is ignored
                isCalc:
                  anyOf:
                    - type: string
                    - type: boolean
                  description: Whether this is a calculation field
                label:
                  type: string
                  description: Field label. Pass as `null` or an empty string to clear.
                newFieldName:
                  type: string
                  description: New field name (for rename)
                newViewName:
                  type: string
                  description: New view name (for move)
                  example: orders
                sampleValues:
                  anyOf:
                    - type: array
                      items:
                        type: string
                    - type: string
                    - type: 'null'
                  description: >
                    Sample values for the field as an array or a comma-separated
                    string. Pass as `null` or an empty string to clear.
                sql:
                  type: string
                  description: SQL expression for the field
                synonyms:
                  anyOf:
                    - type: array
                      items:
                        type: string
                    - type: string
                    - type: 'null'
                  description: >-
                    Synonyms for the field as an array or a comma-separated
                    string. Pass as `null` or an empty string to clear.
                tags:
                  anyOf:
                    - type: array
                      items:
                        type: string
                    - type: string
                  description: Tags for the field as an array or a comma-separated string.
                topicContext:
                  type: string
                  description: Topic context for the field
            examples:
              partialUpdate:
                summary: Update one property
                value:
                  format: percent_1
              clearProperties:
                summary: Clear properties with null
                value:
                  description: null
                  groupLabel: null
                  format: percent_1
      responses:
        '200':
          description: Field updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '400':
          description: >
            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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError400'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError403'
        '404':
          description: Model, view, or field not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError404'
components:
  parameters:
    modelId:
      name: modelId
      schema:
        type: string
        format: uuid
        example: 123e4567-e89b-12d3-a456-426614174000
      required: true
      in: path
      description: The ID of the model.
    branchId:
      name: branch_id
      schema:
        type: string
        format: uuid
        example: 123e4567-e89b-12d3-a456-426614174001
      required: false
      description: Branch ID to use for branch-aware operations
      in: query
  schemas:
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
    ApiError400:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 400
      required:
        - detail
        - status
    ApiError401:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
          example: 'Unauthorized: Missing or invalid API key'
        status:
          type: integer
          description: HTTP status code of the error.
          example: 401
      required:
        - detail
        - status
    ApiError403:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 403
      required:
        - detail
        - status
    ApiError404:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 404
      required:
        - detail
        - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#token-types).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.