Skip to main content
POST
Create 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.

Body

application/json
name
string
required

Page title

Required string length: 1 - 255
contentHtml
string
required

Page body as HTML; sanitized server-side

Required string length: 1 - 1000000
companyId
string<uuid>

Scope the page to one company; omit for a tenant-wide page

folderId
string<uuid>

Custom folder ID (the UUID of a custom: folder key)

summary
string

Short description shown in listings

Maximum string length: 500
sectionLabel
string
Maximum string length: 80
roleIds
string<uuid>[]

Restrict the page to company (client portal) users in these permission-group roles (ids from visibility-roles). Omit to share with all company users in scope; MSP users always see the page.

Required array length: 1 - 50 elements
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}}.

Response

Page created

data
object
required