Documents
Rename document
Deprecated — use PATCH /api/v2/documents/{identifier}/draft (and the related /draft routes). Scheduled for removal on July 31, 2026 (see the Sunset response header).
Updates a document's name, description, and/or identifier. This is a partial update — only provided fields are modified, and at least one of name, description, or identifier must be supplied. When identifier is changed, the previous identifier is retained in the document identifier history and continues to redirect. For published documents, the update goes through a draft/publish workflow automatically.
patch/api/v1/documents/{identifier}
Path parameters
identifierstring required
Document identifier (either document ID or identifier slug)
Example:abc123
Document identifier (either document ID or identifier slug)
Request body
Response
Document updated successfully