Skip to main content
PATCH
Update a column's display preferences

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

table_id
string<uuid>
required
column_id
string<uuid>
required

Body

application/json

Request body for updating a column's display preferences (tri-state PATCH).

color

Semantic column tint token.

Stored as a token rather than a hex value because the grid renders in both a light and a dark theme — a single stored colour is only legible in one of them. The client maps each token to a per-mode value.

Deliberately excludes teal: the brand primary is used for range selection and the anchor outline, so a teal column would read as permanently selected.

Available options:
gray,
red,
orange,
amber,
green,
blue,
purple,
pink
hidden
boolean
pinned
boolean
width

New width in pixels. Set to null to restore the client default.

Required range: 64 <= x <= 720

Response

Successful Response

How one column is displayed, shared by everyone in the organisation.

Always present on a column, whether or not anything has been customised — a column nobody has touched reports the defaults rather than null.

color
enum<string> | null
required

Semantic palette token the client maps per theme; null means untinted.

Available options:
gray,
red,
orange,
amber,
green,
blue,
purple,
pink
hidden
boolean
required

Whether the grid omits the column; its cell values are untouched.

pinned
boolean
required

Whether the column is frozen to the left edge through horizontal scroll.

width
integer | null
required

Rendered width in pixels; null means the client default.