Create Knowledge Base

A knowledge base is the site that holds your help content: its categories, its published articles, its theme and its settings. Admins manage knowledge bases in the knowledge base settings. Each one belongs to exactly one brand, and a brand can have only one knowledge base. The default knowledge base (default: true) uses the org's default brand. When you create a knowledge base, Kustomer also creates its root category. If you don't send a theme, Kustomer also creates a theme for it from the Midtown template.

Addresses

Every knowledge base has a unique subdomain. The help center is served at https://<subdomain>.kustomer.help for US orgs, https://<subdomain>.kustomer.support for EU orgs and https://<subdomain>.kustomer.info for India orgs. The default knowledge base's subdomain is the org name. Other knowledge bases must use the org name followed by a hyphen, such as acme-outdoors: lowercase letters, digits and hyphens, at most 63 characters, not ending in a hyphen. You can't change subdomain or brand after you create the knowledge base, and default is a reserved name.

The public knowledge base endpoints work out which knowledge base to serve from the subdomain of the host you call. Your org host, https://<org>.api.kustomerapp.com, serves the default knowledge base. Pass knowledgeBaseId to read a different one.

Settings

• languages maps each language code to { enabled, title }, where title is the help center's title in that language. defaultLanguage is the knowledge base's main language. New knowledge bases default to en_us and the title "Knowledge Base".
• theme is the ID of the theme the help center uses. Changing it switches the site's look.
• logo, favicon, homepageTitle and metaTags brand the site. noIndex: true asks search engines not to index it.
• baseUrl overrides the address Kustomer uses when it builds links to the help center.

Custom domains

A custom domain serves the help center on your own hostname, such as help.example.com. When you add one, Kustomer requests a TLS certificate for it, and certificateStatus starts as PENDING_VALIDATION. You then add the DNS records that Kustomer provides: one to validate the certificate, and a CNAME that points your hostname at Kustomer. The domain is live once the certificate is ISSUED and domainStatus changes from pending to ready.

Deleting an issued domain starts a removal that runs in the background, and domainStatus is pendingRemoval until it finishes. Removal can't finish while your DNS still points the hostname at Kustomer, so remove the CNAME record too.

Which endpoint to use

This reference has no endpoint that lists knowledge bases. To find a knowledge base ID, read the knowledgeBase relationship of one of its categories, or the knowledgeBase in an article's categories. PATCH only changes the fields you send. Reads need a knowledge base read role, and writes need org.admin.kb.write or the matching permission.