Skip to main content
PATCH
Update a table field

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

table_id
string
required

Table ID

field_id
string
required

Field ID

Body

key
string
Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9_]{0,63}$
schema
object

A table field schema

config
object | null

Per-feature config map keyed by feature name (e.g. button, auto_fill, sync). Each value carries input + optional definitions.

icon

The emoji of a curated icon a user can pick for a table, view, field, or other entity

color
enum<string> | null

The name of the color to use in the UI

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
connection_id
string | null
Maximum string length: 128
unique
boolean
readonly
boolean

Whether the field is readonly.

archived
boolean

Whether the field is archived.

ai_mode
enum<string>
Available options:
none,
auto_fill
on_target_delete
enum<string>

What happens when the referenced target is deleted (ref-typed fields only). restrict forbids deleting the target while any cell still points to it. clear allows the delete and drops those field values on remaining rows. cascade also deletes table rows that reference the target via this field.

Available options:
restrict,
clear,
cascade

Response

200 - application/json
id
string
required
table_id
string
required
key
string
required
type
enum<string>
required
Available options:
id,
string,
number,
boolean,
date,
datetime,
enum,
file,
record,
contact,
user,
chat,
segment,
assistant,
agent
schema
object
required

The file type allows users to upload files

readonly
boolean
required
sortable
boolean
required

Whether views can sort their records by this field.

groupable_in
enum<string>[]
required

View kinds that accept this field as their grouping axis.

Available options:
table,
board,
calendar,
timeline,
list,
gallery
kind
enum<string>
required
Available options:
system