Update Field

Update a case field.

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

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "display_name": "<string>",
  "type": "TEXT",
  "description": "<string>",
  "nullable": true,
  "default": "<string>",
  "reserved": true,
  "options": [
    "<string>"
  ],
  "kind": "LONG_TEXT",
  "required_on_closure": false
}

Authorizations

APIKeyCookieServiceAccountApiKeyBearer

fastapiusersauth · string · cookie · required

Path Parameters

field_id · string · required

workspace_id · string<uuid> · required

Body

application/json

Update a case field.

name · string | null

The name of the column

Required string length: 1 - 100

type · enum<string> | null

The SQL type of the column

Available options: TEXT, INTEGER, NUMERIC, DATE, BOOLEAN, TIMESTAMPTZ, JSONB, SELECT, MULTI_SELECT

Required string length: 1 - 100

nullable · boolean | null

Whether the column can be null

default · any | null

The default value of the column

is_index · boolean | null

True creates a unique index, False drops it, None leaves unchanged.

options · string[] | null

display_name · string | null

Required string length: 1 - 255

required_on_closure · boolean | null

Response

200

application/json

Successful Response

Minimal read model for a case field.

id · string · required

display_name · string · required

type · enum<string> · required

Read-only type for case field metadata.

Available options: TEXT, INTEGER, NUMERIC, DATE, BOOLEAN, TIMESTAMPTZ, JSONB, SELECT, MULTI_SELECT, UUID

description · string · required

nullable · boolean · required

default · string | null · required

reserved · boolean · required

options · string[] | null

kind · enum<string> | null

Semantic kind for case custom fields.

Controls how the field is rendered in the UI without changing the underlying SQL storage type.

Available options: LONG_TEXT, URL

required_on_closure · boolean · default: false