Skip to main content
PATCH
Merge document content

Authorizations

scribe_session
string
cookie
required

Browser session cookie set by the WorkOS sign-in flow.

Headers

X-Base-Version
string
required

The X-Doc-Version token of the GET /content snapshot this edit was made from. An unquoted version token from GET /content, e.g. verCURRENT01.

Example:

"Vt3q9ZkpR1aB"

Path Parameters

id
string
required

Id of the document to merge markdown into.

Body

text/markdown

The edited markdown, based on the X-Base-Version snapshot. A single newline renders as a line break (stacked lines stay on their own lines); use a blank line to start a new paragraph.

The full edited markdown source, based on the base version.

Response

The edit was merged into the live document.

Result of merging API-edited markdown into the live document.

merged
enum<boolean>
required

Always true: the edit was merged into the live document.

Available options:
true
Example:

true

wordCount
integer
required

Word count after the merge.

Example:

1284

charCount
integer
required

Character count after the merge.

Example:

8241

version
string
required

Version token of the merged result — use it as the X-Base-Version of a follow-up edit.

Example:

"Vt3q9ZkpR1aB"