Skip to main content
PATCH
Publish or unpublish a document

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

id
string
required

Knowledge base ID (kb_…).

docId
string
required

Document ID (doc_…).

Body

application/json
is_public
boolean
required

Whether the document should be publicly visible in the help center.

slug
string

Public URL slug (lowercase letters, digits, hyphens). Required when is_public is true.

Maximum string length: 200
Pattern: ^[a-z0-9-]+$
summary
string

Optional public excerpt shown for the article.

Maximum string length: 2000

Response

200 - application/json

The document with its updated publication fields.

data
object
required

A document stored in a knowledge base. Uploaded text is chunked and embedded for retrieval; internal chunk rows are never returned here.

meta
object
required