Skip to main content

Update column layout

Persist the visible and hidden column ID order for a Research Table without changing storage positions.

PATCH/api/tables/{table_id}/columns/layout
HTTP referenceScope columns:writeUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

The endpoint persists the user-facing layout and emits a table update; it does not rewrite storage positions. Table-not-found is returned as 404. Unknown IDs are omitted, duplicate IDs are deduplicated, and storage columns not named in either list are appended in storage order. The stored layout includes version, visible_column_ids, hidden_column_ids, source, user_customized, and updated_at; updated_by is included when available.

Path parameters

  • table_idrequired

    string

    Research Table ID.

Body parameters

  • visibleColumnIds · optional

    array<string>

    Visible column IDs in display order; defaults to [].

  • hiddenColumnIds · optional

    array<string>|null

    Optional hidden column IDs.

Errors

StatusMeaning
401Authentication is required.
403The caller lacks access to the resource or the columns:write scope.
422The request does not satisfy the route or typed request contract.

Docs