For the complete documentation index, see llms.txt. This page is also available as Markdown.

Site customization

Customize the look and feel of your docs site.

Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more.

The SiteCustomizationSettings object

Attributes

titlestring · min: 2 · max: 128Optional

Title to use for the published site. If not defined, it'll fallback to the default content title.

faviconone ofRequired

objectOptional

updatedAtstring · date-timeOptional

When the customization settings were updated. If missing, customization was not updated.

The SiteCustomizationSettings object

Get the branding and visual customization settings for a site

get

Retrieves the full customization configuration for a site. Use this before making updates to read the current state, or to audit branding settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Query parameters

unmaskedbooleanOptionalDeprecated

(Deprecated) Use the getRawCustomizationSettingsById internal endpoint.

Default: false

Responses

200

application/json

titlestring · min: 2 · max: 128Optional

Title to use for the published site. If not defined, it'll fallback to the default content title.

faviconone ofRequired

objectOptional

updatedAtstring · date-timeOptional

When the customization settings were updated. If missing, customization was not updated.

400

Bad Request

application/json

get/orgs/{organizationId}/sites/{siteId}/customization

Update the branding and visual customization settings for a site

put

Replaces the full customization configuration for a site. This is a full replacement — unset fields revert to defaults. Use the GET endpoint first to read the current settings before making targeted changes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Body

titlestring · min: 2 · max: 128Optional

Title to use for the published site. If not defined, it'll fallback to the default content title.

faviconone ofRequired

objectOptional

Responses

200

application/json

titlestring · min: 2 · max: 128Optional

Title to use for the published site. If not defined, it'll fallback to the default content title.

faviconone ofRequired

objectOptional

updatedAtstring · date-timeOptional

When the customization settings were updated. If missing, customization was not updated.

400

Bad Request

application/json

put/orgs/{organizationId}/sites/{siteId}/customization

Get the customization overrides for a site space

get

Retrieves the customization settings that override the site-level branding for a specific site space, such as a language variant or content version. Returns the effective settings with site-level defaults where no override is set. Use this before applying or removing overrides.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

siteSpaceIdstringRequired

The unique id of the site-space relationship

Query parameters

unmaskedbooleanOptionalDeprecated

(Deprecated) Use the getRawCustomizationSettingsById internal endpoint.

Default: false

Responses

200

application/json

titlestring · min: 2 · max: 128Optional

Title to use for the published site. If not defined, it'll fallback to the default content title.

faviconone ofRequired

objectOptional

updatedAtstring · date-timeOptional

When the customization settings were updated. If missing, customization was not updated.

400

Bad Request

application/json

get/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization

Delete a site space customization settings

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

siteSpaceIdstringRequired

The unique id of the site-space relationship

Responses

204

Customization settings did not exist

205

Site space customization removed

400

Bad Request

application/json

delete/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization

No content

Override branding and customization settings for a specific site space

patch

Applies customization overrides to a specific site space, such as a language variant or content version, that take precedence over the site-level settings. Only provided fields are overridden; set a field to null to clear its override and fall back to the site-level value.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

siteSpaceIdstringRequired

The unique id of the site-space relationship

Body

The settings that overrides the site customization settings.

titleone ofOptional

Title to use for the published site variant. If not defined, the title will not be changed. If set to null, the title will be unset and will fallback to the content title.

string · min: 2 · max: 128Optional

Title of the site

nullOptional

localizedTitleone ofOptional

Localized titles for the site variant, keyed by locale. If not defined, the localized title will not be changed. If set to null, all localized titles will be removed.

nullOptional

faviconone ofOptional

The favicon to use. Set to null to reset the override.

objectOptional

nullOptional

Responses

200

application/json

titlestring · min: 2 · max: 128Optional

Title to use for the published site. If not defined, it'll fallback to the default content title.

faviconone ofRequired

objectOptional

updatedAtstring · date-timeOptional

When the customization settings were updated. If missing, customization was not updated.

400

Bad Request

application/json

patch/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization

Last updated 12 hours ago

Was this helpful?

{ "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "styling": { "theme": "clean", "primaryColor": { "light": "text", "dark": "text" }, "tint": { "color": { "light": "text", "dark": "text" } }, "infoColor": { "light": "text", "dark": "text" }, "successColor": { "light": "text", "dark": "text" }, "warningColor": { "light": "text", "dark": "text" }, "dangerColor": { "light": "text", "dark": "text" }, "corners": "straight", "depth": "subtle", "links": "default", "font": "ABCFavorit", "monospaceFont": "FiraCode", "icons": "regular", "codeTheme": { "default": { "light": "default-light", "dark": "default-light" }, "openapi": { "light": "default-light", "dark": "default-light" } }, "sidebar": { "background": "default", "list": "default" }, "search": "prominent" }, "favicon": { "icon": { "light": "https://example.com", "dark": "https://example.com" } }, "header": { "logo": { "light": "https://example.com", "dark": "https://example.com" }, "primaryLink": { "kind": "file", "file": "text", "space": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "style": "link", "to": { "kind": "file", "file": "text", "space": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } } ], "condition": "text" } ] }, "footer": { "logo": { "light": "https://example.com", "dark": "https://example.com" }, "groups": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } } ] } ], "copyright": "text" }, "announcement": { "enabled": true, "message": "text", "localizedMessage": { "ANY_ADDITIONAL_PROPERTY": "text" }, "link": { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } }, "style": "info" }, "themes": { "default": "light", "toggeable": true }, "feedback": { "enabled": true }, "ai": { "mode": "none", "suggestions": [ "text" ] }, "advancedCustomization": { "enabled": true }, "pageActions": { "items": [ "assistant" ] }, "externalLinks": { "target": "self" }, "pagination": { "enabled": true }, "trademark": { "enabled": true }, "privacyPolicy": { "url": "https://example.com" }, "socialPreview": { "url": "https://example.com" }, "socialAccounts": [ { "platform": "twitter", "handle": "text", "display": { "footer": true, "header": false } } ], "insights": { "trackingCookie": true }, "updatedAt": "2026年07月03日T02:16:58.480Z" }

PUT /v1/orgs/{organizationId}/sites/{siteId}/customization HTTP/1.1 Host: api.gitbook.com Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 2273 { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "styling": { "theme": "clean", "primaryColor": { "light": "text", "dark": "text" }, "tint": { "color": { "light": "text", "dark": "text" } }, "infoColor": { "light": "text", "dark": "text" }, "successColor": { "light": "text", "dark": "text" }, "warningColor": { "light": "text", "dark": "text" }, "dangerColor": { "light": "text", "dark": "text" }, "corners": "straight", "depth": "subtle", "links": "default", "font": "ABCFavorit", "monospaceFont": "FiraCode", "icons": "regular", "codeTheme": { "default": { "light": "default-light", "dark": "default-light" }, "openapi": { "light": "default-light", "dark": "default-light" } }, "sidebar": { "background": "default", "list": "default" }, "search": "prominent" }, "favicon": { "icon": { "light": "https://example.com", "dark": "https://example.com" } }, "header": { "logo": { "light": "https://example.com", "dark": "https://example.com" }, "primaryLink": { "kind": "file", "file": "text", "space": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "style": "link", "to": { "kind": "file", "file": "text", "space": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } } ], "condition": "text" } ] }, "footer": { "logo": { "light": "https://example.com", "dark": "https://example.com" }, "groups": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } } ] } ], "copyright": "text" }, "announcement": { "enabled": true, "message": "text", "localizedMessage": { "ANY_ADDITIONAL_PROPERTY": "text" }, "link": { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } }, "style": "info" }, "themes": { "default": "light", "toggeable": true }, "feedback": { "enabled": true }, "ai": { "mode": "none", "suggestions": [ "text" ] }, "advancedCustomization": { "enabled": true }, "pageActions": { "items": [ "assistant" ] }, "externalLinks": { "target": "self" }, "pagination": { "enabled": true }, "trademark": { "enabled": true }, "privacyPolicy": { "url": "https://example.com" }, "socialPreview": { "url": "https://example.com" }, "socialAccounts": [ { "platform": "twitter", "handle": "text", "display": { "footer": true, "header": false } } ], "insights": { "trackingCookie": true } }

PATCH /v1/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization HTTP/1.1 Host: api.gitbook.com Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 2059 { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "styling": { "theme": "clean", "primaryColor": { "light": "text", "dark": "text" }, "infoColor": { "light": "text", "dark": "text" }, "successColor": { "light": "text", "dark": "text" }, "warningColor": { "light": "text", "dark": "text" }, "dangerColor": { "light": "text", "dark": "text" }, "tint": { "color": { "light": "text", "dark": "text" } }, "corners": "straight", "depth": "subtle", "links": "default", "icons": "regular", "sidebar": { "background": "default", "list": "default" }, "search": "prominent", "codeTheme": { "default": { "light": "default-light", "dark": "default-light" }, "openapi": { "light": "default-light", "dark": "default-light" } } }, "favicon": { "icon": { "light": "https://example.com", "dark": "https://example.com" } }, "announcement": { "enabled": true, "message": "text", "localizedMessage": { "ANY_ADDITIONAL_PROPERTY": "text" }, "link": { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } }, "style": "info" }, "header": { "logo": { "light": "https://example.com", "dark": "https://example.com" }, "primaryLink": { "kind": "file", "file": "text", "space": "text" }, "backgroundColor": { "light": "text", "dark": "text" }, "linkColor": { "light": "text", "dark": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "style": "link", "to": { "kind": "file", "file": "text", "space": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } } ], "condition": "text" } ] }, "footer": { "logo": { "light": "https://example.com", "dark": "https://example.com" }, "groups": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "links": [ { "title": "text", "localizedTitle": { "ANY_ADDITIONAL_PROPERTY": "text" }, "to": { "kind": "file", "file": "text", "space": "text" } } ] } ], "copyright": null }, "themes": { "default": "light", "toggeable": null }, "feedback": { "enabled": null }, "externalLinks": { "target": "self" }, "pagination": { "enabled": null }, "trademark": { "enabled": null }, "privacyPolicy": { "url": "https://example.com" }, "socialPreview": { "url": "https://example.com" } }