---
title: "Update Field"
method: PATCH
path: "/workspaces/{workspace_id}/case-fields/{field_id}"
tags: ["cases"]
---

# Update Field

`PATCH /workspaces/{workspace_id}/case-fields/{field_id}`

## Request

- Base URL: `https://platform.tracecat.com/api`
- URL: `https://platform.tracecat.com/api/workspaces/{workspace_id}/case-fields/{field_id}`
- Auth: one of:
  - API key in cookie `fastapiusersauth`
  - HTTP bearer

Update a case field.

## Path parameters

- `field_id` string, required
- `workspace_id` string, uuid, required

## Request body

- CaseFieldUpdate: Update a case field.
  - `name` string, nullable: The name of the column
  - `type` 'TEXT' | 'INTEGER' | 'NUMERIC' | 'DATE' | 'BOOLEAN' | 'TIMESTAMPTZ' | 'JSONB' | 'SELECT' | 'MULTI_SELECT': Supported SQL types.
  - `nullable` boolean, nullable: Whether the column can be null
  - `default` unknown
  - `is_index` boolean, nullable: True creates a unique index, False drops it, None leaves unchanged.
  - `options` string[], nullable
  - `display_name` string, nullable
  - `required_on_closure` boolean, nullable

## Response `200`

Successful Response

- CaseFieldReadMinimal: Minimal read model for a case field.
  - `id` string, required
  - `display_name` string, required
  - `type` 'TEXT' | 'INTEGER' | 'NUMERIC' | 'DATE' | 'BOOLEAN' | 'TIMESTAMPTZ' | 'JSONB' | 'SELECT' | 'MULTI_SELECT' | 'UUID', required: Read-only type for case field metadata.
  - `description` string, required
  - `nullable` boolean, required
  - `default` string, nullable, required
  - `reserved` boolean, required
  - `options` string[], nullable
  - `kind` 'LONG_TEXT' | 'URL': Semantic kind for case custom fields. Controls how the field is rendered in the UI without changing the underlying SQL storage type.
  - `required_on_closure` boolean

## Other responses

- `422`: Validation Error

---

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