Skip to main content
PATCH
Rename a saved document and/or update its out-of-flow parts (headers, footers, footnotes, endnotes, comments, sections).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null

Path Parameters

document_id
string
required

Body

application/json

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.

title
string | null

New document title.

Required string length: 1 - 255
parts
Parts · object | null

Document-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.

base_parts
Base Parts · object | null

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