Skip to main content
PATCH
Update documentation page

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id
string<uuid>
required

Built-in page ID (a source=custom document from the documents list)

Body

application/json

Provide at least one of name, contentHtml, summary or isClientTemplate.

name
string

New page title

Required string length: 1 - 255
contentHtml
string

Replacement body as HTML (replaces the whole body; sanitized server-side). Fetch the current content first for a partial edit.

Required string length: 1 - 1000000
summary
string
Maximum string length: 500
changeSummary
string

One-line description stored on the revision

Maximum string length: 255
isClientTemplate
boolean

Client template: merge-field tokens in the HTML fill in for each client who reads it, and each company user sees only their own company's version. Tokens: {{company_name}}, {{company_logo}}, {{company_address}}, {{company_website}}, {{company_domain}}, {{company_contact_name}}, {{company_contact_email}}, {{company_contact_phone}}, {{tenant_name}}, {{effective_date}}, {{today}}, {{role_<team_role_slug>}} and {{role_<team_role_slug>_email}}. Pass false to turn it back into an ordinary page.

Response

Page updated

data
object
required