Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

OverviewGetting startedWhat is Saasco?

SDK

Quick startTrackingIdentifyConfigurationWidgetsProperties

MCP

Quick startHow it worksAuthorizationTool reference

REST API

Quick start
Set up KnowledgePopulate the knowledge base
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

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.

PUT
/projects/{projectId}/knowledge/help-centers/{id}

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project that owns the help center.

idrequiredstring

ID of the help center to update.

Request Body

application/json

displayNamestring
googleAnalyticsIdstring | null
themeobject | null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://www.saasco.com/api/v2/projects/string/knowledge/help-centers/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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": 50,
    "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": 50,
    "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": 50,
    "footerLogo": "string",
    "footerLayout": "simple",
    "footerText": "string",
    "footerSocialDisplay": "label",
    "footerSocialLinks": [
      {
        "platform": "string",
        "url": "string"
      }
    ],
    "footerLinks": [
      {
        "title": "string",
        "url": "http://example.com"
      }
    ],
    "footerBackgroundColor": "string",
    "footerTextColor": "string"
  }
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Create Help Center

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.

Delete Help Center

Deletes a help center and every collection inside it. Articles survive but are unlinked from their collections, so they disappear from navigation while their content remains. Returns 404 if the help center does not exist. Cannot be undone.