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

Authorizations

X-API-Key
string
header
required

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 tint token, shared by a column and by a column GROUP.

Stored as a token rather than a hex value because the grid renders in both a light and a dark theme, and 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.

Lives HERE rather than in table_column_prefs, where it started, because two domains now need it and the layering only allows one direction. A column's tint is stored in table_column_prefs (org-shared appearance, keyed by column) while a group's is a field on the group row itself in table_column, and table_column_prefs sits ABOVE table_column in the domain layers, so the token had to move DOWN to be reachable from both. table_column_prefs.types re-exports it, which is why that move touched no existing import.

One enum for both on purpose: a colour token is a shared vocabulary (a team agreeing that amber means "needs review" is agreeing about it across columns and groups alike) and the organisation's renaming of the palette (table_column_color_labels) is keyed by this token, so a second enum would give groups colours the rename dialog could not name.

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

Hide the column from the grid, or show it. A signed-in person's choice is their own and stays theirs over the team's; an API key sets the team's.

pinned

Pin the column to the left edge, or unpin it. A signed-in person's choice is their own and stays theirs over the team's; an API key sets the team's.

width

New width in pixels, for a signed-in person their own. Null makes a person's column follow the team's width again; from an API key it restores the client default for the team.

Required range: 64 <= x <= 720

Response

Successful Response

How one column is displayed to the caller.

Hidden, pinned and width are the caller's own where they set one, laid over the team's; the colour tint is the team's. An API key sees the team's alone. 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.