Grist Octri Preview
PATCH/docs/{docId}

Update document metadata

Updates a document's metadata without changing its contents. Supply name, isPinned, or both to change the document's name or pinned status.

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

1 parameter · 2 body fields
docIdstringrequired
The document's UUID.

Document metadata changes; include name, isPinned, or both. Document contents are not modified.

isPinnedbooleanoptional
Whether the document is pinned.
namestringoptional
The document's name.

1 status code
200Returns a success response after updating the document's metadata.

Error handling

The docId path parameter must be a string UUID. When supplied, name must be a string and isPinned must be a boolean.