Create documentation page
Create a built-in documentation page (inline HTML custom document), optionally scoped to a company and placed in a custom folder. The page gets a first revision and a visibility rule: shared with all company users by default, or restricted to roleIds. Company users always create pages scoped to their own company. Requires documentation.write and write_settings_documentation or write_settings_onboarding.
Authorizations
Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.
Body
Page title
1 - 255Page body as HTML; sanitized server-side
1 - 1000000Scope the page to one company; omit for a tenant-wide page
Custom folder ID (the UUID of a custom: folder key)
Short description shown in listings
50080Restrict 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.
1 - 50 elementsClient 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