Skip to main content
PATCH
Rename / move a document

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200
If-Match
string
required

Current entity revision, quoted (e.g. "3"), from the last ETag.

Path Parameters

documentId
string
required

Document id

Body

application/json
name
string
Required string length: 1 - 255
folderId
string | null
Required string length: 1 - 200

Response

{ success: true, document } + ETag

success
boolean
required
{key}
any