Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

Quick StartWhat is Saasco?

Analytics

CRM

Email Marketing

Knowledge

getGet Help CenterpostCreate Help CenterputUpdate Help CenterdelDelete Help CentergetGet Public Help CenterpostSet Help Center Custom DomainpostVerify Help Center Custom DomaindelRemove Help Center Custom DomainpostExtract Brand Info

Support

Projects

Help Center

Verify Help Center Custom Domain

Re-checks the DNS for the configured custom domain and stores the result on the help center as customDomainVerified. Poll this after adding the DNS records; it is safe to call repeatedly. A domain that is still misconfigured comes back with customDomainVerified: false rather than an error. Only a project with no custom domain set returns 404.

POST
/projects/{projectId}/knowledge/help-center/domain/verify

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project that owns the help center.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://www.saasco.com/api/v2/projects/string/knowledge/help-center/domain/verify"
{
  "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",
    "headerTitle": "string",
    "headerLinks": [
      {
        "title": "string",
        "url": "http://example.com"
      }
    ],
    "headerBackgroundEnabled": true,
    "headerBackgroundColor": "string",
    "heroWelcomeMessage": "string",
    "heroBackgroundType": "color",
    "heroBackgroundColor": "string",
    "heroBackgroundImage": "string",
    "heroGradientColors": [
      "string"
    ],
    "heroTextColor": "string",
    "heroHeight": 200,
    "heroSearchBarWidth": 300,
    "heroAlignment": "left",
    "heroCornerRadius": 50,
    "collectionsShowDescriptions": true,
    "articleShowToc": true,
    "articleShowRelated": true,
    "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": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Set Help Center Custom Domain

Points a hostname you own at the project's help center. The domain is registered with the hosting layer and the DNS records you need to add are returned on the help center as `customDomainVerificationDNS`. It does not serve traffic until DNS is in place and Verify Help Center Custom Domain reports success. Setting a new domain replaces any existing one, and a hostname already claimed by another help center is rejected with 409.

Remove Help Center Custom Domain

Detaches the custom domain from the help center and clears its verification state. The help center stays available on its Saasco-hosted URL. Returns 404 if no custom domain is configured. DNS records at your registrar are not touched. Remove them yourself.