Skip to main content
PUT
Replace document content

Authorizations

scribe_session
string
cookie
required

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

Headers

If-Match
string | null

Conditional replace: the quoted ETag from GET /content. A quoted entity tag, e.g. "verCURRENT01".

Example:

"\"Vt3q9ZkpR1aB\""

X-Base-Version
string | null

Conditional replace: the unquoted X-Doc-Version from GET /content. Takes precedence over If-Match. An unquoted version token, e.g. verCURRENT01.

Example:

"Vt3q9ZkpR1aB"

Path Parameters

id
string
required

Id of the document whose markdown to replace.

Body

text/markdown

The new markdown source. 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 markdown source to store.

Response

The content was replaced.

Counters recomputed after a content update.

wordCount
integer
required

Word count after the update.

Example:

1280

charCount
integer
required

Character count after the update.

Example:

8214