Grist Octri Preview
PATCH/docs/{docId}/tables

Modify table metadata

Updates metadata for existing tables in a document. Identify each table by its current id and use fields to rename it with tableId or set its on-demand loading behavior with onDemand.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
docIdstringrequired
The document identifier in UUID format.

Metadata changes for existing tables. Each item in the required tables array must include the table’s current id and a fields object.

tablesarray<object>required
Tables to modify. Each item identifies the current table with `id` and supplies changes in `fields`, such as a new `tableId` or an `onDemand` value.

1 status code
200Returns confirmation that the table metadata updates were applied.

Error handling

The docId path parameter must identify a document. The tables array is required, and each item must include the table’s current id and a fields object containing the metadata to change.