Update a document
PATCH /api/v1/documents/{id}
PATCH
/api/v1/documents/{id}
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string format: uuid
Request Body required
Section titled “Request Body required ”object
title
string
text
Markdown body — replaces editor content when set
string
content
TipTap JSON — takes precedence over text when both are sent
published
True = publish, false = unpublish / draft
boolean
Responses
Section titled “ Responses ”Updated document
object
data
required
object
id
required
string format: uuid
title
required
Document title
string
emoji
required
Optional emoji prefix for the document icon
string | null
text
required
Plain-text content (read-only, derived from body)
string | null
collectionId
required
string | null format: uuid
parentDocumentId
required
string | null format: uuid
teamId
required
string format: uuid
createdById
required
string | null format: uuid
lastModifiedById
required
string | null format: uuid
publishedAt
required
Null = draft
string | null format: date-time
archivedAt
required
string | null format: date-time
deletedAt
required
string | null format: date-time
revision
required
integer
sortOrder
required
number
fullWidth
required
boolean
collaborativeId
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Validation error
object
error
required
Human-readable error message
string
Not found
object
error
required
Human-readable error message
string