Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

OverviewGetting startedAgent setupWhat is Saasco?

SDK

Quick startTrackingIdentifyConfigurationWidgetsProperties

MCP

Quick startHow it worksAuthorizationTool reference
Skills for agents

REST API

Quick start
getGet Help CenterpostCreate Help CenterputUpdate Help CenterdelDelete Help CentergetGet Public Help CenterpostSet Help Center Custom DomainpostVerify Help Center Custom DomaindelRemove Help Center Custom Domain
KnowledgeHelp Center

Create Help Center

View as MarkdownAgent setup

Creates a help center: the public site that hosts a project's collections and articles. The site is reachable once a collection has a published public article. It starts on a Saasco-hosted URL; attach your own hostname afterwards with Set Help Center Custom Domain.

POST
/projects/{projectId}/knowledge/help-centers

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project that will own the help center.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

displayNamerequiredstring
googleAnalyticsIdstring | null
themeobject | null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/projects/string/knowledge/help-centers" \  -H "Content-Type: application/json" \  -d '{    "displayName": "string"  }'
{  "id": "string",  "createdAt": "string",  "updatedAt": "string",  "projectId": "string",  "displayName": "string",  "url": "string",  "customDomain": "string",  "customDomainVerified": true,  "customDomainVerificationDNS": [    {      "domain": "string",      "reason": "string",      "type": "string",      "value": "string"    }  ],  "googleAnalyticsId": "string",  "websiteEnabled": true,  "theme": {    "backgroundColor": "string",    "authorAvatarColor": "string",    "fontFamily": "string",    "secondaryFontFamily": "string",    "cornerRadius": 0,    "showArticleAuthors": true,    "logo": "string",    "favicon": "http://example.com",    "headerTitle": "string",    "headerLinks": [      {        "title": "string",        "url": "http://example.com"      }    ],    "headerBackgroundEnabled": true,    "headerBackgroundColor": "string",    "sidebarEnabled": true,    "sidebarRowSize": "compact",    "heroWelcomeMessage": "string",    "heroHeadingSize": "24",    "heroHeadingWeight": "400",    "heroHeadingTracking": "0",    "heroHeadingLeading": "1.05",    "heroBackgroundType": "color",    "heroBackgroundColor": "string",    "heroBackgroundImage": "string",    "heroGradientColors": [      "string"    ],    "heroTextColor": "string",    "heroHeight": 200,    "heroSearchBarWidth": 300,    "heroAlignment": "left",    "heroCornerRadius": 0,    "collectionsShowDescriptions": true,    "articleShowToc": true,    "articleShowRelated": true,    "articleTitleSize": "28",    "articleSectionSize": "18",    "articleSubsectionSize": "14",    "articleTypeSize": "12",    "articleTypeLeading": "1.6",    "articleTypeFlow": "1",    "articleMeasure": "60",    "articleMonoFont": "string",    "cardStyle": "card",    "cardDisplayMode": "default",    "cardShowMedia": "icon",    "cardColor": "string",    "sectionOrder": [      "articles"    ],    "articlesSectionEnabled": true,    "ticketsSectionEnabled": true,    "contentSectionEnabled": true,    "articlesSectionLayout": 1,    "articlesSectionTitle": "string",    "articlesSectionArticleIds": [      "string"    ],    "collectionsSectionLayout": 1,    "collectionsSectionStyle": "classic",    "collectionsIconColor": "string",    "collectionsIconColors": {      "property1": "string",      "property2": "string"    },    "collectionsIconBackgroundEnabled": true,    "collectionsIconBackgroundColor": "string",    "collectionsIconBackgroundType": "color",    "collectionsIconGradientColors": [      "string"    ],    "contentSectionTitle": "string",    "contentSectionTitleColor": "string",    "contentSectionDescription": "string",    "contentSectionDescriptionColor": "string",    "contentSectionStyle": "card",    "contentSectionBackgroundType": "color",    "contentSectionBackgroundColor": "string",    "contentSectionBackgroundImage": "string",    "contentSectionGradientColors": [      "string"    ],    "contentSectionButtonEnabled": true,    "contentSectionButtonText": "string",    "contentSectionButtonUrl": "http://example.com",    "contentSectionButtonColor": "string",    "contentSectionButtonTextColor": "string",    "contentSectionButtonCornerRadius": 0,    "footerLogo": "string",    "footerLayout": "simple",    "footerText": "string",    "footerSocialDisplay": "label",    "footerSocialLinks": [      {        "platform": "string",        "url": "string"      }    ],    "footerLinks": [      {        "title": "string",        "url": "http://example.com"      }    ],    "footerBackgroundColor": "string",    "footerTextColor": "string"  }}

Get Help Center

Fetches the project's help center with its full configuration: theme, custom domain and verification state, analytics ID. Returns `null` if the project has no help center yet.

Update Help Center

Updates a help center's presentation and settings: display name, theme, and Google Analytics ID. Only the fields present in the body are written. The public site is reachable once a collection has a published public article. Set theme.favicon to a public image URL to use that image as the browser-tab icon; null clears it. Custom domains are managed separately through the domain endpoints.