Skip to main content
PATCH
/
case-fields
/
{field_id}
Update Field
curl --request PATCH \
  --url https://api.example.com/case-fields/{field_id} \
  --header 'Content-Type: application/json' \
  --cookie fastapiusersauth= \
  --data '
{
  "name": "<string>",
  "type": "TEXT",
  "nullable": true,
  "default": "<unknown>",
  "is_index": true
}
'
{}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
field_id
string
required

Query Parameters

​
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,
BOOLEAN,
TIMESTAMP,
TIMESTAMPTZ,
JSONB,
UUID
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

Whether the column is an index

Response

Successful Response