API ReferenceDocuments

Update Document

Update document metadata. Omitted fields are unchanged. An explicitly null folder_id moves the document to root; a UUID moves it into that owned folder.

Authentication

AuthorizationBearer

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

Path parameters

document_idUUIDRequired
Stable document ID.

Request

This endpoint expects an object.
titlestringOptional
New display title. Omit to leave unchanged.
folder_idUUIDOptional
Omit to leave unchanged, send null to move to root, or send an owned folder UUID.
archivedbooleanOptional
Archive or restore the document. Archived documents are moved to root.

Response

This endpoint returns an object.
idUUID
Stable document ID.
typestring
Document source type.
titlestring
Display title.
statusstring
Current document or processing status.
archivedboolean
Whether the document is archived.
created_atdatetime
Creation time.
folder_idUUIDOptional
Containing folder, or null for root.
updated_atdatetimeOptional
Last update time, when available.
textstringOptional
Visible plain text for completed text and transcript documents when available.
htmlstringOptional

Editor-compatible HTML for completed documents when available.

Errors

400
Invalid Document
401
Authentication Error
404
Document Not Found
429
Rate Limit Error