PATCH /v1/documents/{documentId}
Partially update a document with a JSON request body.
PATCH /v1/documents/{documentId} updates an existing document.
Authentication
Send an organization API key in x-api-key or
Authorization: Bearer <key>.
Path Parameters
| Name | Type | Description |
|---|---|---|
documentId | string (uuid) | UUID of the document to update. |
Request Body
Send a JSON object containing the fields you want to change.
| Name | Type | Description |
|---|---|---|
name | string or null | Document title. Send null or an empty string to reset it to Untitled Document. |
folderId | string (uuid) or null | Folder that contains the document. Send null to remove it from its folder. |
author | string or null | Member ID of the document author. |
content | array | Structured document content. |
contentFormat | markdown, html, or tiptap | Format used for content. |
labelIds | array of strings (uuid) | Labels assigned to the document. |
metadata | array | Document metadata and field definitions. |
fields | object | Values for document custom fields. |
objectIds | array of strings (uuid) | Objects linked to the document. |
documentVisitId | string (uuid) | Identifier used to associate the update with a document visit. |
A document that is not a draft cannot change its title, folder, author,
content, content format, labels, or visit ID. Those changes return
423 Locked; metadata, custom fields, and linked objects remain editable.
Example
curl -X PATCH "https://api.blueputto.com/v1/documents/DOCUMENT_ID" \
-H "x-api-key: YOUR_API_KEY" \
-H "content-type: application/json" \
-d '{"name":"Condition report — revised"}'Success Response
200 OK
{
"data": {}
}Error Responses
400 Bad Request401 Unauthorized404 Not Found423 Locked429 Too Many Requests