Skip to main content
PATCH
Update a table view

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required
view_id
string<uuid>
required

Body

application/json

Request body for updating a saved view (tri-state PATCH semantics).

description

New description. Set to null to clear.

Required string length: 1 - 2000
hidden_column_ids
string<uuid>[]
Maximum array length: 500
is_default

True makes this the table's default view (the one a link naming no view opens on, for a person with no last view of the table), standing down whichever view held it. False clears the flag, leaving the table with no default.

name
string
Required string length: 1 - 255
position
integer
Required range: x >= 0
sorts

New sort keys, in priority order. Empty restores display order.

Maximum array length: 3
where
TableRowsWhereSchema · object | null

The whole predicate for a rows query.

items mixes conditions with groups under one joiner, so A and (B or C) is an AND over [A, group(OR, [B, C])]. Send no where at all rather than an empty one, so "no filter" stays a single state.

The cap is on LEAVES, not on items: eight conditions cost eight correlated EXISTS clauses whether they are grouped or not, and it is the clause count that the query planner pays for.

Response

Successful Response

A saved view: named sort/filter/hidden-column overrides for one table.

created_at
string<date-time>
required
description
string | null
required
hidden_column_ids
string<uuid>[]
required

Columns the view hides.

id
string<uuid>
required
is_default
boolean
required

Whether opening the table with no view named applies this one, for a person with no last view of the table. At most one view per table carries it.

name
string
required
position
integer
required

Display position in the view switcher; ties break by name.

sorts
TableRowSortSchema · object[]
required

The view's sort keys, in priority order.

updated_at
string<date-time>
required
where
TableRowsWhereSchema · object | null
required

Predicate tree rows must satisfy while the view is applied.