Skip to main content
PATCH
Save document content and/or title

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Path Parameters

id
string
required

Body

application/json
content
object
contactId
string<uuid> | null

Link the document to a CRM contact of the same company, or unlink it with null. Omit to leave unchanged. Linking does not change who can open it.

markdown
string

Replace the whole page with this Markdown. Pages only. Do not combine with content or appendMarkdown.

Maximum string length: 500000
appendMarkdown
string

Add this Markdown to the end of the page and keep everything else. Pages only. Do not combine with content or markdown.

Maximum string length: 500000
title
string

New title. Omit for a content-only autosave.

Maximum string length: 200
icon
string | null

Page icon (emoji). Send null to clear it. Omit to leave unchanged.

Maximum string length: 32
coverImage
string | null

Cover image URL or gradient key. Send null to clear. Omit to leave unchanged.

Maximum string length: 500
kbEnabled
boolean

Opt the document in/out of the Mira knowledge base. Omit to leave unchanged.

parentDocumentId
string | null

Move the document under another page (or to the root with null). Omit to leave unchanged. Cycle-, company- and depth-validated server-side.

Response

Saved.