TRtracecat
cases

Update Field

Update a case field.

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

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    • API key in cookie fastapiusersauth
    • or HTTP bearer

Path parameters

field_idstring required
workspace_idstring uuid required

Request body

namestring nullable

The name of the column

type'TEXT' | 'INTEGER' | 'NUMERIC' | 'DATE' | 'BOOLEAN' | 'TIMESTAMPTZ' | 'JSONB' | 'SELECT' | 'MULTI_SELECT'

Supported SQL types.

nullableboolean nullable

Whether the column can be null

defaultunknown
is_indexboolean nullable

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

optionsstring[] nullable
display_namestring nullable
required_on_closureboolean nullable

Response

Successful Response

idstring required
display_namestring required
type'TEXT' | 'INTEGER' | 'NUMERIC' | 'DATE' | 'BOOLEAN' | 'TIMESTAMPTZ' | 'JSONB' | 'SELECT' | 'MULTI_SELECT' | 'UUID' required

Read-only type for case field metadata.

descriptionstring required
nullableboolean required
defaultstring nullable required
reservedboolean required
optionsstring[] 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_closureboolean

Changes

No recorded changes to this operation across all 1 revision of this API.