Documents

Rename a document

PATCH
/documents/{document_id}

Rename a document, moving its stored object to the new name.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Path Parameters

document_id*string

Resource identifier: document_id.

Formatuuid

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128
Idempotency-Key*string

A unique key for this intended write. Reuse it only for an identical retry.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/documents/123e4567-e89b-42d3-a456-426614174000" \  -H "Idempotency-Key: 123e4567-e89b-42d3-a456-426614174000" \  -H "Content-Type: application/json" \  -d '{    "file_name": "invoice-2026-09.pdf"  }'
{  "id": "123e4567-e89b-42d3-a456-426614174000",  "tenant_id": "123e4567-e89b-42d3-a456-426614174000",  "workspace_id": "123e4567-e89b-42d3-a456-426614174000",  "space_id": "123e4567-e89b-42d3-a456-426614174000",  "folder_id": "123e4567-e89b-42d3-a456-426614174000",  "uploaded_by": {    "id": "123e4567-e89b-42d3-a456-426614174000",    "name": "Customer documents"  },  "file_name": "invoice-2026-09.pdf",  "content_type": "application/pdf",  "file_size": 0,  "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf",  "status": "PENDING_UPLOAD",  "created_at": "2026-09-04T12:00:00Z",  "doc_origin": "UPLOADED",  "live_content_type": "MARKDOWN",  "has_active_collab_session": false,  "has_content": false}