Skip to main content
PATCH
Update a table

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

Body

application/json

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

auto_run

Whether data changes (cell edits, new rows) request recompute runs by themselves. Off, formula cells go stale and wait for an explicit run.

description

New description. Set to null to clear.

Required string length: 1 - 2000
keep_existing_results

Whether a manual run-all skips cells that already hold a good value, touching only the errored, empty and stale ones. Off re-runs every cell in scope.

name
string
Required string length: 1 - 255
shared_as_template

Publish this table's SHAPE — its columns, their configuration and one sample row — to anyone with the link, with no sign-in. Never its rows. Off by default.

Response

Successful Response

A table definition with its authoritative row counter.

auto_run
boolean
required

Whether data changes request recompute runs by themselves. Column-definition changes always recompute.

created_at
string<date-time>
required
description
string | null
required
id
string<uuid>
required
keep_existing_results
boolean
required

Whether a manual run-all only fills the errored, empty and stale cells rather than recomputing every cell in scope.

name
string
required
row_count
integer
required

Exact row count, maintained atomically by row mutations.

updated_at
string<date-time>
required
deleted_at
string<date-time> | null

When the table was moved to trash; null for a live table.

is_favorite
boolean
default:false

Whether the CALLING USER starred this table. Per-user, so a teammate may see a different value. Always false for API-key callers, which have no user to have preferences.

last_viewed_at
string<date-time> | null

When the calling user last opened this table; null means never.

owner_display_name
string | null

The owner's name, resolved for display. Null when there is no owner or the account has no name to show.

owner_user_id
string | null

Who created the table. Null for tables older than this field and for anything a background job created. NOT an access control — every member of the organisation can open and edit every table.

shared_as_template
boolean
default:false

Whether this table's shape is readable by anyone with the link, with no sign-in. Never its rows.

tags
TableTagSchema · object[]

The organisation tags assigned to this table, alphabetical.