v1

latestOpenAPI 3.1.02026-07-261344388.3 KB

Document

Update a document

Update document properties such as name or metadata.

put/api/projects/{projectId}/documents/{documentId}

Path parameters

documentIdstring uuid required

Document unique identifier

projectIdstring uuid required

Project unique identifier

Request body

namestring

New document name

contentobject

Document content to update

metaobject

Document metadata to merge

publishboolean

Whether to publish after updating

deletedboolean

Whether to include deleted documents

Example request

{
  "name": "Sample document"
}

Response

Updated document

idstring uuid required

Document unique identifier

keystring required

Materialized lowercase path based on the name

pathstring required

Materialized path based on the name

namestring required

Document name

type'f' | 'd' | 'e' required

Document type (file, directory, or external file)

metaobject

Document metadata

contentTypestring

Content MIME type

sizenumber

Document size in bytes

parentIdstring uuid nullable

Parent document ID

projectIdstring uuid required

Project ID

publishedIdstring uuid nullable

Currently published version ID

publishedAtstring nullable

Publication timestamp

updatedAtstring

Last update timestamp

deletedAtstring nullable

Deletion timestamp if soft deleted