Skip to main content
PATCH
/
knowledge
Update knowledge base settings and configuration
curl --request PATCH \
  --url https://api.getfernand.com/knowledge \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "PiedPiper Help Center",
  "description": "<string>",
  "company_name": "PiedPiper",
  "company_url": "piedpiper.com",
  "subdomain": "piedpiper",
  "custom_domain": "help.piedpiper.com",
  "favicon": "<string>",
  "language": "en",
  "color_scheme": "light",
  "light_logo": "<string>",
  "light_accent_color": "#00a0ff",
  "dark_logo": "<string>",
  "dark_accent_color": "#00a0ff",
  "custom_css": "<string>",
  "custom_js": "<string>",
  "indexable": true
}
'
{
  "subdomain": "help",
  "custom_domain": "help.piedpiper.com",
  "favicon": "https://cdn.example.com/knowledge/uuid/images/favicon.png",
  "language": "en",
  "color_scheme": "light",
  "light_logo": "<string>",
  "light_accent_color": "#00a0ff",
  "dark_logo": "<string>",
  "dark_accent_color": "#00a0ff",
  "custom_css": "<string>",
  "custom_js": "<string>",
  "previous_url": "<string>",
  "valid_custom_domain": true,
  "last_verified_dns": "2023-11-07T05:31:56Z",
  "indexable": true,
  "title": "Help Center",
  "description": "Welcome to the PiedPiper help center",
  "company_name": "PiedPiper help center",
  "company_url": "https://piedpiper.com"
}
Updates the knowledge base configuration. Changes to custom domains are validated and configured with the hosting provider. Image assets can be provided as URLs or base64-encoded data and are automatically uploaded to CDN storage.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Body

application/json
​
title
string

Main title for the knowledge base homepage.

Maximum string length: 250
Example:

"PiedPiper Help Center"

​
description
string | null

Description text shown on the knowledge base homepage.

Maximum string length: 1000
​
company_name
string | null

Company name displayed in the knowledge base.

Maximum string length: 250
Example:

"PiedPiper"

​
company_url
string | null

Company website URL (without http/https prefix).

Maximum string length: 250
Example:

"piedpiper.com"

​
subdomain
string

Subdomain for accessing the knowledge base (e.g., 'piedpiper' for piedpiper.fernand.help).

Maximum string length: 50
Example:

"piedpiper"

​
custom_domain
string | null

Custom domain for the knowledge base (without http/https prefix).

Maximum string length: 250
Example:

"help.piedpiper.com"

​
favicon
string | null

Favicon URL or base64-encoded PNG image data.

​
language
enum<string> | null

Language code for the knowledge base (null for browser detection).

Available options:
en,
fr,
de,
es,
it,
pt,
pl,
tr,
sv,
nl,
dk
Maximum string length: 5
Example:

"en"

​
color_scheme
enum<string> | null

Color scheme preference for the knowledge base.

Available options:
light,
dark
​
light_logo
string | null

Logo URL or base64-encoded image for light mode (jpg, png, svg).

​
light_accent_color
string

Accent color for light mode (hex color code).

Example:

"#00a0ff"

​
dark_logo
string | null

Logo URL or base64-encoded image for dark mode (jpg, png, svg).

​
dark_accent_color
string

Accent color for dark mode (hex color code).

Example:

"#00a0ff"

​
custom_css
string | null

Custom CSS to apply to the knowledge base (max 8MB).

Maximum string length: 8000000
​
custom_js
string | null

Custom JavaScript to apply to the knowledge base (max 8MB).

Maximum string length: 8000000
​
indexable
boolean

Whether the knowledge base should be indexed by search engines.

Response

Knowledge base settings updated successfully.

Knowledge base settings combined with language-specific content. Inherits all properties from Knowledge model and adds language-specific fields.

​
subdomain
string | null

Subdomain for accessing the knowledge base (e.g., 'piedpiper' for piedpiper.fernand.help).

Maximum string length: 50
Example:

"help"

​
custom_domain
string | null

Custom domain configured for the knowledge base.

Maximum string length: 250
Example:

"help.piedpiper.com"

​
favicon
string | null

URL to the favicon image stored in CDN.

Maximum string length: 250
Example:

"https://cdn.example.com/knowledge/uuid/images/favicon.png"

​
language
string | null

Default language code for the knowledge base (null for browser detection).

Maximum string length: 5
Example:

"en"

​
color_scheme
enum<string> | null

Preferred color scheme for the knowledge base. Defaults to null, which will use the user system's preferences.

Available options:
light,
dark
Maximum string length: 5
​
light_logo
string | null

URL to the logo image for light mode.

Maximum string length: 250
​
light_accent_color
string

Hex color code for accent color in light mode.

Maximum string length: 7
Example:

"#00a0ff"

​
dark_logo
string | null

URL to the logo image for dark mode.

Maximum string length: 250
​
dark_accent_color
string

Hex color code for accent color in dark mode.

Maximum string length: 7
Example:

"#00a0ff"

​
custom_css
string | null

Custom CSS applied to the knowledge base.

​
custom_js
string | null

Custom JavaScript applied to the knowledge base.

​
previous_url
string | null

Previous URL if migrated from another help system.

Maximum string length: 250
​
valid_custom_domain
boolean

Whether the custom domain DNS is properly configured and verified.

​
last_verified_dns
string<date-time> | null

Timestamp of the last successful DNS verification.

​
indexable
boolean

Whether the knowledge base should be indexed by search engines.

​
title
string

Main title displayed on the knowledge base homepage.

Maximum string length: 250
Example:

"Help Center"

​
description
string | null

Description text shown on the knowledge base homepage.

Maximum string length: 1000
Example:

"Welcome to the PiedPiper help center"

​
company_name
string | null

Company name displayed in the knowledge base.

Maximum string length: 250
Example:

"PiedPiper help center"

​
company_url
string | null

Company website URL.

Maximum string length: 250
Example:

"https://piedpiper.com"