table-ui-prefs

Update a column's display preferences

Partially update how one column is displayed: hidden, pinned, width, colour tint (omitted fields are left untouched). Hidden, pinned and width are the CALLING USER's own: they change this person's Default view and nobody else's, over the team's layout. The colour tint is shared by everyone in the organisation. A caller with no person behind it (an API key) sets the team's layout. Cosmetic only: this never touches the column definition, never bumps the columns change watermark, and never requests a recompute run. A request that sets nothing is a no-op and leaves the preferences watermark unmoved. Answers with the column's preferences as the caller now sees them.

patch/tables/{table_id}/columns/{column_id}/ui-prefs/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/ui-prefs/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

table_idstring uuid required
column_idstring uuid required

Request body

Response

Successful Response

color'gray' | 'red' | 'orange' | 'amber' | 'green' | 'blue' | 'purple' | 'pink' required

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.

hiddenboolean required

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

pinnedboolean required

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

widthinteger nullable required

Rendered width in pixels; null means the client default.

Changes

No recorded changes to this operation across all 1 revision of this API.