• Features
  • Pricing
Get Started

OverviewList DocumentsCreate DocumentGet DocumentUpdate DocumentTrash DocumentRestore DocumentDelete PermanentlyDuplicate Document

Documents

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

NameTypeDescription
documentIdstring (uuid)UUID of the document to update.

Request Body

Send a JSON object containing the fields you want to change. The public OpenAPI schema keeps the document payload flexible and does not enumerate the exact keys.

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 '{}'

Success Response

200 OK

{
  "data": {}
}

Error Responses

  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 423 Locked
  • 429 Too Many Requests

GET /v1/documents/{documentId}

Retrieve a single document by its UUID.

DELETE /v1/documents/{documentId}

Move a document to the trash without permanently deleting it.

On this page

AuthenticationPath ParametersRequest BodyExampleSuccess ResponseError Responses