Skip to main content
PATCH
Update document help-center publication

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Knowledge base id (kb_ prefixed).

docId
string
required

Document id (kb_doc_ prefixed), as returned by GET /knowledge-bases/:id/documents.

Body

application/json
is_public
boolean
required

Set true to expose the document on the public help center; false hides it.

slug
string

Public URL segment for the help-center page (lowercase letters, digits, hyphens; max 200 chars).

summary
string

Optional public summary shown on the help-center page (max 2000 chars).

Response

The document, in the standard { data, meta } envelope (meta carries request_id + timestamp).

The document, in the standard { data, meta } envelope (meta carries request_id + timestamp).