Skip to main content
PATCH
Rename a document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string<uuid>
required
documentId
string<uuid>
required

Body

application/json
name
string
required
Required string length: 1 - 200

Response

The renamed document summary.

object
string
required
Allowed value: "document"
id
string<uuid>
required
documentId
string<uuid>
required

Legacy alias of id — kept for pre-restructure consumers.

filename
string
required

Last segment of the VFS path — the user-facing filename.

vfsPath
string
required
kind
string
required
status
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required