Rename a saved document and/or update its out-of-flow parts (headers, footers, footnotes, endnotes, comments, sections).
Rename one of your saved documents and/or update its out-of-flow parts. Parts are
the document’s out-of-flow content — headers/footers, footnote and endnote bodies,
comments, and per-section page geometry. Every fragment is sanitized on write, writes
are versioned and safe under concurrent editors, and parts revert with the document.
A title-only call behaves exactly as the original rename (response status:"renamed");
a parts call returns the new version, the part families written (parts_updated),
and any concurrently-overwritten families (parts_conflicts, newest-write-wins).
Note: parts editing is moving to the document body itself — when the new model is
active on this deployment, a parts payload returns 400 parts_moved_to_chunks and
part content is edited exactly like any other document content (via chat or the
document write endpoints).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
PATCH /v1/documents/{id} body — rename a document and/or update its out-of-flow parts. Both fields optional; at least one must be present.
New document title.
1 - 255Document-parts patch — the document's OUT-OF-FLOW content, keyed by any of: sections, headers, footers, footnotes, endnotes, comments. Each key you send REPLACES that whole part family; a null value clears it; keys you omit are untouched. Every HTML fragment is sanitized server-side. Headers/footers are keyed by section index with default/first/even variants; dynamic page fields use cached text.
Optional concurrency guard: the parts subtree your edit was based on (as last read). If another writer changed one of the same part families since, your write still lands (newest-write-wins) and the overwritten families are reported in parts_conflicts.
Response
Successful Response

