Skip to main content
PATCH
Update a table

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

Body

name
string

Human-readable name (e.g. "Companies"). 1-128 chars.

Required string length: 1 - 128
description
string | null

Optional long-form description of what the table represents.

Maximum string length: 512
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
display_field_id
string | null

Encoded id of the TableField whose value renders as the record headline. Must belong to this table and not be archived. Pass null to clear.

Maximum string length: 128
archived
boolean

Visibility flag. Archived tables are hidden from default lists. No effect on records, fields, or behavior; reversible at any time.

Response

200 - application/json
id
string
required
type
enum<string>
required
Available options:
custom,
contacts,
chats,
users
name
string | null
required

The name of the table.

Example:

"Companies"

description
string | null
required

The description of the table.

Example:

"Companies are organizations that own and manage other organizations."

icon
required

The picked icon. Null renders the default table icon.

color
enum<string> | null
required

The picked icon tint. Null renders the default color.

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
display_field_id
string | null
required

The id of the display field.

archived
boolean
required

Whether the table is archived.

position
integer
required

Manual display order within the org.

fields
object[]
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required