# Source: https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-customization.md

# Site customization

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

```json
{"openapi":"3.0.3","info":{"title":"GitBook API","version":"0.0.1-beta"},"components":{"schemas":{"SiteCustomizationSettings":{"type":"object","properties":{"title":{"description":"Title to use for the published site. If not defined, it'll fallback to the default content title.","$ref":"#/components/schemas/SiteTitle"},"styling":{"type":"object","properties":{"theme":{"$ref":"#/components/schemas/CustomizationTheme"},"primaryColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"tint":{"$ref":"#/components/schemas/CustomizationTint"},"infoColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"successColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"warningColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"dangerColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"corners":{"$ref":"#/components/schemas/CustomizationCorners"},"depth":{"$ref":"#/components/schemas/CustomizationDepth"},"links":{"$ref":"#/components/schemas/CustomizationLinksStyle"},"font":{"$ref":"#/components/schemas/CustomizationFont"},"monospaceFont":{"$ref":"#/components/schemas/CustomizationMonospaceFont"},"background":{"deprecated":true,"$ref":"#/components/schemas/CustomizationBackground"},"icons":{"$ref":"#/components/schemas/CustomizationIconsStyle"},"codeTheme":{"type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"},"openapi":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"}},"required":["default","openapi"]},"sidebar":{"type":"object","properties":{"background":{"$ref":"#/components/schemas/CustomizationSidebarBackgroundStyle"},"list":{"$ref":"#/components/schemas/CustomizationSidebarListStyle"}},"required":["background","list"]},"search":{"$ref":"#/components/schemas/CustomizationSearchStyle"}},"required":["theme","primaryColor","infoColor","successColor","warningColor","dangerColor","corners","depth","links","font","monospaceFont","codeTheme","background","icons","sidebar","search"]},"internationalization":{"type":"object","deprecated":true,"properties":{"locale":{"$ref":"#/components/schemas/CustomizationLocale"}},"required":["locale"]},"favicon":{"$ref":"#/components/schemas/CustomizationFavicon"},"header":{"type":"object","properties":{"preset":{"$ref":"#/components/schemas/CustomizationHeaderPreset"},"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"primaryLink":{"description":"Destination to open when visitors click the site title/logo in the header.","$ref":"#/components/schemas/ContentRef"},"backgroundColor":{"deprecated":true,"description":"Color of the background in the header. This value is now deprecated in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"linkColor":{"deprecated":true,"description":"Color of the links in the header. This value is now deprecated and will be phased out in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationHeaderItem"}}},"required":["preset","links"]},"footer":{"type":"object","properties":{"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationFooterGroup"}},"copyright":{"type":"string","maxLength":300}},"required":["groups"]},"announcement":{"$ref":"#/components/schemas/CustomizationAnnouncement"},"themes":{"description":"Customization options for the dark/light theme modes.\n","type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemeMode"},"toggeable":{"description":"Should the reader be able to switch between dark and light mode","type":"boolean"}},"required":["default","toggeable"]},"pdf":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, PDF export is enabled for the published site."}},"required":["enabled"]},"feedback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, feedback gathering is enabled"}},"required":["enabled"]},"ai":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/CustomizationAIMode"},"suggestions":{"$ref":"#/components/schemas/CustomizationSuggestedQuestions"}},"required":["mode"]},"advancedCustomization":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, Advanced customization is enabled"}},"required":["enabled"]},"git":{"type":"object","properties":{"showEditLink":{"type":"boolean","description":"Whether the published site should show a link to edit the content on the git provider set up in the Git Sync"}},"required":["showEditLink"]},"pageActions":{"type":"object","properties":{"externalAI":{"type":"boolean","description":"Whether actions to open ChatGPT, Anthropic, etc. should be available in the page menu."},"markdown":{"type":"boolean","description":"Whether the copy and open the markdown version of the page should be available in the page menu."},"mcp":{"type":"boolean","description":"Whether an action to connect to the docs using the MCP server should be available in the page menu."}},"required":["externalAI","markdown","mcp"]},"externalLinks":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/SiteExternalLinksTarget"}},"required":["target"]},"pagination":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the pagination navigation should be displayed on pages."}},"required":["enabled"]},"trademark":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the GitBook trademark (\"Powered by GitBook\") should be visible"}},"required":["enabled"]},"privacyPolicy":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialPreview":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialAccounts":{"$ref":"#/components/schemas/SiteSocialAccounts"},"insights":{"type":"object","properties":{"trackingCookie":{"type":"boolean","description":"Whether GitBook identifies the visitor on the site using a cookie.","default":true}},"required":["trackingCookie"]}},"required":["styling","internationalization","favicon","header","footer","themes","pdf","feedback","ai","advancedCustomization","trademark","externalLinks","pagination","pageActions","git","privacyPolicy","socialPreview","socialAccounts","insights"]},"SiteTitle":{"type":"string","description":"Title of the site","minLength":2,"maxLength":128},"CustomizationTheme":{"type":"string","description":"The theme to apply to the site. Supercedes the old header preset themes.\n- `clean`: Modern theme featuring translucency and minimally-styled elements.\n- `muted`: Sophisticated theme with decreased contrast between elements.\n- `bold`: High-impact theme with prominent colors and strong contrasts.\n- `gradient`: Trendy theme featuring colorful gradients and splashes of color.\n","enum":["clean","muted","bold","gradient"]},"CustomizationThemedColor":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/Color"},"dark":{"$ref":"#/components/schemas/Color"}},"required":["light","dark"]},"Color":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$"},"CustomizationTint":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/CustomizationThemedColor"}},"required":["color"]},"CustomizationCorners":{"type":"string","enum":["straight","rounded","circular"]},"CustomizationDepth":{"type":"string","description":"The degree of visual depth (through shadows, gradients and elevation effects) of elements on the site.\n- `subtle`: Subtle shadows and minimal elevation.\n- `flat`: Flat elements, no shadows and no elevation.\n","enum":["subtle","flat"]},"CustomizationLinksStyle":{"type":"string","description":"The style used for regular links in the main content, header and footer. Sidebar items are styled separately.\n- `default`: Links are colored in the primary color and feature an underline in the same color.\n- `accent`: Links are colored the same as body text and feature an underline in the primary color.\n","enum":["default","accent"]},"CustomizationFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultFont":{"type":"string","enum":["ABCFavorit","Inter","Roboto","RobotoSlab","OpenSans","SourceSansPro","Lato","Ubuntu","Raleway","Merriweather","Overpass","NotoSans","IBMPlexSerif","Poppins","FiraSans"]},"CustomizationFontDefinitionInput":{"type":"object","description":"Defines a font family along with its various font-face declarations for use in CSS '@font-face' rules.","properties":{"id":{"type":"string","description":"A globally unique identifier for the font definition."},"custom":{"type":"boolean","description":"Whether the font is a custom font. If false, this font is provided by GitBook."},"fontFamily":{"$ref":"#/components/schemas/FontFamily"},"fontFaces":{"type":"array","description":"A list of font-face definitions, specifying variations such as weight and style.","items":{"$ref":"#/components/schemas/FontFace"},"minItems":1}},"required":["id","custom","fontFamily","fontFaces"]},"FontFamily":{"type":"string","description":"The human-readable font-family name used in CSS (e.g., \"Open Sans\", \"Playfair Display\").","minLength":1,"maxLength":50},"FontFace":{"type":"object","description":"A single font-face declaration specifying the weight and source files for a particular variation of the font.","properties":{"weight":{"$ref":"#/components/schemas/FontWeight"},"sources":{"type":"array","description":"Font source files provided in supported formats (e.g., woff2, woff).","items":{"$ref":"#/components/schemas/FontSource"},"minItems":1}},"required":["weight","sources"]},"FontWeight":{"type":"integer","description":"Numeric representation of the font weight (400=regular, 500=medium, 700=bold, 900=black).","minimum":1,"maximum":1000},"FontSource":{"type":"object","description":"A font file referenced within a font-face declaration, specifying the file's location and format.","properties":{"url":{"description":"The absolute or relative URL pointing to the font file.","$ref":"#/components/schemas/URL"},"format":{"type":"string","description":"The format of the font file. Prefer 'woff2' for modern browsers.","enum":["woff2","woff"]}},"required":["url"]},"URL":{"type":"string","format":"uri","maxLength":2048},"CustomizationMonospaceFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultMonospaceFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultMonospaceFont":{"type":"string","enum":["FiraCode","IBMPlexMono","JetBrainsMono","SourceCodePro","RobotoMono","SpaceMono","DMMono","Inconsolata"]},"CustomizationBackground":{"type":"string","enum":["plain","match"],"deprecated":true,"description":"The background style has been deprecated and will be removed in a future release. Use the `tint` settings instead."},"CustomizationIconsStyle":{"type":"string","enum":["regular","solid","duotone","light","thin"]},"CustomizationThemedCodeTheme":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/CustomizationCodeTheme"},"dark":{"$ref":"#/components/schemas/CustomizationCodeTheme"}},"required":["light","dark"]},"CustomizationCodeTheme":{"type":"string","enum":["default-light","default-dark","monochrome-light","monochrome-dark","andromeeda","aurora-x","ayu-dark","catppuccin-frappe","catppuccin-latte","catppuccin-macchiato","catppuccin-mocha","dark-plus","dracula","dracula-soft","everforest-dark","everforest-light","github-dark","github-dark-default","github-dark-dimmed","github-dark-high-contrast","github-light","github-light-default","github-light-high-contrast","gruvbox-dark-hard","gruvbox-dark-medium","gruvbox-dark-soft","gruvbox-light-hard","gruvbox-light-medium","gruvbox-light-soft","houston","kanagawa-dragon","kanagawa-lotus","kanagawa-wave","laserwave","light-plus","material-theme","material-theme-darker","material-theme-lighter","material-theme-ocean","material-theme-palenight","min-dark","min-light","monokai","night-owl","nord","one-dark-pro","one-light","plastic","poimandres","red","rose-pine","rose-pine-dawn","rose-pine-moon","slack-dark","slack-ochin","snazzy-light","solarized-dark","solarized-light","synthwave-84","tokyo-night","vesper","vitesse-black","vitesse-dark","vitesse-light"]},"CustomizationSidebarBackgroundStyle":{"type":"string","description":"- `default`: No background, content sits directly against sidebar edge.\n- `filled`: Muted background color that extends to sidebar edges.\n","enum":["default","filled"]},"CustomizationSidebarListStyle":{"type":"string","description":"- `default`: Simple list items without special styling, groups are inset with a line.\n- `pill`: Rounded capsule shape around selected/active items.\n- `line`: Continuous line next to all items, with colored line part for selected/active items.\n","enum":["default","pill","line"]},"CustomizationSearchStyle":{"type":"string","description":"The style of the search button.\n- `prominent`: large search bar in the middle of the header, with less room for other header items,\n- `subtle`: small search bar in the corner of the header, with more room for other header items.\n","enum":["prominent","subtle"]},"CustomizationLocale":{"type":"string","description":"Language for the UI element","deprecated":true,"enum":["en","fr","es","zh","ja","de","nl","no","pt-br","ru"]},"CustomizationFavicon":{"oneOf":[{"type":"object","properties":{"icon":{"$ref":"#/components/schemas/CustomizationThemedURL"}},"required":["icon"]},{"type":"object","properties":{"emoji":{"$ref":"#/components/schemas/Emoji"}},"required":["emoji"]},{"type":"object","properties":{},"additionalProperties":false}]},"CustomizationThemedURL":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/URL"},"dark":{"$ref":"#/components/schemas/URL"}},"required":["light","dark"]},"Emoji":{"type":"string","maxLength":50,"format":"emoji","description":"Unicode codepoint or character of the emoji"},"CustomizationHeaderPreset":{"type":"string","deprecated":true,"description":"The header preset to use for the site. This is a legacy setting and the site styling theme should be used instead.","enum":["default","bold","contrast","custom","none"]},"ContentRef":{"description":"A relative reference to content in GitBook.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefPage"},{"$ref":"#/components/schemas/ContentRefAnchor"},{"$ref":"#/components/schemas/ContentRefUser"},{"$ref":"#/components/schemas/ContentRefCollection"},{"$ref":"#/components/schemas/ContentRefSpace"},{"$ref":"#/components/schemas/ContentRefReusableContent"},{"$ref":"#/components/schemas/ContentRefOpenAPI"}]},"ContentRefFile":{"type":"object","properties":{"kind":{"type":"string","enum":["file"]},"file":{"type":"string"},"space":{"description":"ID of the space the file is in. The file is considered as in the current space if none is provided.","type":"string"}},"required":["kind","file"]},"ContentRefURL":{"type":"object","properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string"}},"required":["kind","url"]},"ContentRefPage":{"type":"object","properties":{"kind":{"type":"string","enum":["page"]},"page":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"}},"required":["kind","page"]},"ContentRefAnchor":{"type":"object","properties":{"kind":{"type":"string","enum":["anchor"]},"anchor":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"},"page":{"description":"ID of the page the anchor is in. The anchor is considered as in the current page if none is provided.","type":"string"}},"required":["kind","anchor"]},"ContentRefUser":{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user":{"type":"string"}},"required":["kind","user"]},"ContentRefCollection":{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"collection":{"type":"string"}},"required":["kind","collection"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ContentRefReusableContent":{"type":"object","properties":{"kind":{"type":"string","enum":["reusable-content"]},"reusableContent":{"type":"string"},"space":{"type":"string","description":"The space in which the reusable content is defined. If undefined, the reusable content is assumed to be in the same space as the content reference."}},"required":["kind","reusableContent"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"CustomizationHeaderItem":{"type":"object","properties":{"title":{"type":"string"},"style":{"type":"string","enum":["link","button-primary","button-secondary"]},"to":{"oneOf":[{"$ref":"#/components/schemas/ContentRef"},{"type":"string","nullable":true,"enum":[null]}]},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}},"condition":{"description":"Conditional expression used to evaluate whether the header item should be shown to the site's visitor.","$ref":"#/components/schemas/Expression"}},"required":["title","links","to"]},"CustomizationContentLink":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/CustomizationContentLinkTitle"},"to":{"$ref":"#/components/schemas/ContentRef"}},"required":["title","to"]},"CustomizationContentLinkTitle":{"type":"string","maxLength":64},"Expression":{"type":"string","description":"Expression to evaluate","minLength":0,"maxLength":1024},"CustomizationFooterGroup":{"type":"object","properties":{"title":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}}},"required":["title","links"]},"CustomizationAnnouncement":{"type":"object","properties":{"enabled":{"description":"Whether to show the site's announcement.","type":"boolean"},"message":{"$ref":"#/components/schemas/CustomizationAnnouncementMessage"},"link":{"description":"The content or URL the announcement links to when clicked.","$ref":"#/components/schemas/CustomizationContentLink"},"style":{"description":"The style of the announcement. Used to style the banner with the right semantic color and enable/disable features like hiding the banner.","type":"string","enum":["info","warning","danger","success"]}},"required":["enabled","message","style"]},"CustomizationAnnouncementMessage":{"description":"The text content of the announcement.","type":"string","minLength":2,"maxLength":128},"CustomizationThemeMode":{"type":"string","enum":["light","dark"]},"CustomizationAIMode":{"type":"string","enum":["none","search","assistant"]},"CustomizationSuggestedQuestions":{"type":"array","description":"Suggested questions to display at the start of the chosen AI mode.","items":{"$ref":"#/components/schemas/CustomizationSuggestedQuestion"},"maxItems":5},"CustomizationSuggestedQuestion":{"type":"string","minLength":3,"maxLength":64},"SiteExternalLinksTarget":{"type":"string","description":"How external links should open when clicked.\n- `self`: External links open in the current tab.\n- `blank`: External links open in a new browser tab.\n","enum":["self","blank"]},"SiteSocialAccounts":{"type":"array","description":"The social accounts of the site.","items":{"$ref":"#/components/schemas/SiteSocialAccount"},"maxItems":10},"SiteSocialAccount":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/SiteSocialAccountPlatform"},"handle":{"$ref":"#/components/schemas/SiteSocialAccountHandle"},"display":{"type":"object","properties":{"footer":{"type":"boolean","default":true}},"required":["footer"]}},"required":["platform","handle","display"]},"SiteSocialAccountPlatform":{"description":"The platform of the social handle.","type":"string","enum":["twitter","instagram","facebook","linkedin","github","discord","slack","youtube","tiktok","reddit","bluesky","mastodon","threads","medium"]},"SiteSocialAccountHandle":{"description":"A handle on a social platform, without prefixes like the @ symbol.","type":"string","minLength":1,"maxLength":128}}}}
```

## GET /orgs/{organizationId}/sites/{siteId}/customization

> Get a site customization settings

```json
{"openapi":"3.0.3","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-customization","description":"Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteCustomizationSettings\" grouped=\"false\" %}\n    The SiteCustomizationSettings object\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"type":"string"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteCustomizationUnmasked":{"name":"unmasked","in":"query","description":"(Deprecated) Use the getRawCustomizationSettingsById internal endpoint.","deprecated":true,"schema":{"type":"boolean","default":false}}},"schemas":{"SiteCustomizationSettings":{"type":"object","properties":{"title":{"description":"Title to use for the published site. If not defined, it'll fallback to the default content title.","$ref":"#/components/schemas/SiteTitle"},"styling":{"type":"object","properties":{"theme":{"$ref":"#/components/schemas/CustomizationTheme"},"primaryColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"tint":{"$ref":"#/components/schemas/CustomizationTint"},"infoColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"successColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"warningColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"dangerColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"corners":{"$ref":"#/components/schemas/CustomizationCorners"},"depth":{"$ref":"#/components/schemas/CustomizationDepth"},"links":{"$ref":"#/components/schemas/CustomizationLinksStyle"},"font":{"$ref":"#/components/schemas/CustomizationFont"},"monospaceFont":{"$ref":"#/components/schemas/CustomizationMonospaceFont"},"background":{"deprecated":true,"$ref":"#/components/schemas/CustomizationBackground"},"icons":{"$ref":"#/components/schemas/CustomizationIconsStyle"},"codeTheme":{"type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"},"openapi":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"}},"required":["default","openapi"]},"sidebar":{"type":"object","properties":{"background":{"$ref":"#/components/schemas/CustomizationSidebarBackgroundStyle"},"list":{"$ref":"#/components/schemas/CustomizationSidebarListStyle"}},"required":["background","list"]},"search":{"$ref":"#/components/schemas/CustomizationSearchStyle"}},"required":["theme","primaryColor","infoColor","successColor","warningColor","dangerColor","corners","depth","links","font","monospaceFont","codeTheme","background","icons","sidebar","search"]},"internationalization":{"type":"object","deprecated":true,"properties":{"locale":{"$ref":"#/components/schemas/CustomizationLocale"}},"required":["locale"]},"favicon":{"$ref":"#/components/schemas/CustomizationFavicon"},"header":{"type":"object","properties":{"preset":{"$ref":"#/components/schemas/CustomizationHeaderPreset"},"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"primaryLink":{"description":"Destination to open when visitors click the site title/logo in the header.","$ref":"#/components/schemas/ContentRef"},"backgroundColor":{"deprecated":true,"description":"Color of the background in the header. This value is now deprecated in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"linkColor":{"deprecated":true,"description":"Color of the links in the header. This value is now deprecated and will be phased out in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationHeaderItem"}}},"required":["preset","links"]},"footer":{"type":"object","properties":{"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationFooterGroup"}},"copyright":{"type":"string","maxLength":300}},"required":["groups"]},"announcement":{"$ref":"#/components/schemas/CustomizationAnnouncement"},"themes":{"description":"Customization options for the dark/light theme modes.\n","type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemeMode"},"toggeable":{"description":"Should the reader be able to switch between dark and light mode","type":"boolean"}},"required":["default","toggeable"]},"pdf":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, PDF export is enabled for the published site."}},"required":["enabled"]},"feedback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, feedback gathering is enabled"}},"required":["enabled"]},"ai":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/CustomizationAIMode"},"suggestions":{"$ref":"#/components/schemas/CustomizationSuggestedQuestions"}},"required":["mode"]},"advancedCustomization":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, Advanced customization is enabled"}},"required":["enabled"]},"git":{"type":"object","properties":{"showEditLink":{"type":"boolean","description":"Whether the published site should show a link to edit the content on the git provider set up in the Git Sync"}},"required":["showEditLink"]},"pageActions":{"type":"object","properties":{"externalAI":{"type":"boolean","description":"Whether actions to open ChatGPT, Anthropic, etc. should be available in the page menu."},"markdown":{"type":"boolean","description":"Whether the copy and open the markdown version of the page should be available in the page menu."},"mcp":{"type":"boolean","description":"Whether an action to connect to the docs using the MCP server should be available in the page menu."}},"required":["externalAI","markdown","mcp"]},"externalLinks":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/SiteExternalLinksTarget"}},"required":["target"]},"pagination":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the pagination navigation should be displayed on pages."}},"required":["enabled"]},"trademark":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the GitBook trademark (\"Powered by GitBook\") should be visible"}},"required":["enabled"]},"privacyPolicy":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialPreview":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialAccounts":{"$ref":"#/components/schemas/SiteSocialAccounts"},"insights":{"type":"object","properties":{"trackingCookie":{"type":"boolean","description":"Whether GitBook identifies the visitor on the site using a cookie.","default":true}},"required":["trackingCookie"]}},"required":["styling","internationalization","favicon","header","footer","themes","pdf","feedback","ai","advancedCustomization","trademark","externalLinks","pagination","pageActions","git","privacyPolicy","socialPreview","socialAccounts","insights"]},"SiteTitle":{"type":"string","description":"Title of the site","minLength":2,"maxLength":128},"CustomizationTheme":{"type":"string","description":"The theme to apply to the site. Supercedes the old header preset themes.\n- `clean`: Modern theme featuring translucency and minimally-styled elements.\n- `muted`: Sophisticated theme with decreased contrast between elements.\n- `bold`: High-impact theme with prominent colors and strong contrasts.\n- `gradient`: Trendy theme featuring colorful gradients and splashes of color.\n","enum":["clean","muted","bold","gradient"]},"CustomizationThemedColor":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/Color"},"dark":{"$ref":"#/components/schemas/Color"}},"required":["light","dark"]},"Color":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$"},"CustomizationTint":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/CustomizationThemedColor"}},"required":["color"]},"CustomizationCorners":{"type":"string","enum":["straight","rounded","circular"]},"CustomizationDepth":{"type":"string","description":"The degree of visual depth (through shadows, gradients and elevation effects) of elements on the site.\n- `subtle`: Subtle shadows and minimal elevation.\n- `flat`: Flat elements, no shadows and no elevation.\n","enum":["subtle","flat"]},"CustomizationLinksStyle":{"type":"string","description":"The style used for regular links in the main content, header and footer. Sidebar items are styled separately.\n- `default`: Links are colored in the primary color and feature an underline in the same color.\n- `accent`: Links are colored the same as body text and feature an underline in the primary color.\n","enum":["default","accent"]},"CustomizationFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultFont":{"type":"string","enum":["ABCFavorit","Inter","Roboto","RobotoSlab","OpenSans","SourceSansPro","Lato","Ubuntu","Raleway","Merriweather","Overpass","NotoSans","IBMPlexSerif","Poppins","FiraSans"]},"CustomizationFontDefinitionInput":{"type":"object","description":"Defines a font family along with its various font-face declarations for use in CSS '@font-face' rules.","properties":{"id":{"type":"string","description":"A globally unique identifier for the font definition."},"custom":{"type":"boolean","description":"Whether the font is a custom font. If false, this font is provided by GitBook."},"fontFamily":{"$ref":"#/components/schemas/FontFamily"},"fontFaces":{"type":"array","description":"A list of font-face definitions, specifying variations such as weight and style.","items":{"$ref":"#/components/schemas/FontFace"},"minItems":1}},"required":["id","custom","fontFamily","fontFaces"]},"FontFamily":{"type":"string","description":"The human-readable font-family name used in CSS (e.g., \"Open Sans\", \"Playfair Display\").","minLength":1,"maxLength":50},"FontFace":{"type":"object","description":"A single font-face declaration specifying the weight and source files for a particular variation of the font.","properties":{"weight":{"$ref":"#/components/schemas/FontWeight"},"sources":{"type":"array","description":"Font source files provided in supported formats (e.g., woff2, woff).","items":{"$ref":"#/components/schemas/FontSource"},"minItems":1}},"required":["weight","sources"]},"FontWeight":{"type":"integer","description":"Numeric representation of the font weight (400=regular, 500=medium, 700=bold, 900=black).","minimum":1,"maximum":1000},"FontSource":{"type":"object","description":"A font file referenced within a font-face declaration, specifying the file's location and format.","properties":{"url":{"description":"The absolute or relative URL pointing to the font file.","$ref":"#/components/schemas/URL"},"format":{"type":"string","description":"The format of the font file. Prefer 'woff2' for modern browsers.","enum":["woff2","woff"]}},"required":["url"]},"URL":{"type":"string","format":"uri","maxLength":2048},"CustomizationMonospaceFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultMonospaceFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultMonospaceFont":{"type":"string","enum":["FiraCode","IBMPlexMono","JetBrainsMono","SourceCodePro","RobotoMono","SpaceMono","DMMono","Inconsolata"]},"CustomizationBackground":{"type":"string","enum":["plain","match"],"deprecated":true,"description":"The background style has been deprecated and will be removed in a future release. Use the `tint` settings instead."},"CustomizationIconsStyle":{"type":"string","enum":["regular","solid","duotone","light","thin"]},"CustomizationThemedCodeTheme":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/CustomizationCodeTheme"},"dark":{"$ref":"#/components/schemas/CustomizationCodeTheme"}},"required":["light","dark"]},"CustomizationCodeTheme":{"type":"string","enum":["default-light","default-dark","monochrome-light","monochrome-dark","andromeeda","aurora-x","ayu-dark","catppuccin-frappe","catppuccin-latte","catppuccin-macchiato","catppuccin-mocha","dark-plus","dracula","dracula-soft","everforest-dark","everforest-light","github-dark","github-dark-default","github-dark-dimmed","github-dark-high-contrast","github-light","github-light-default","github-light-high-contrast","gruvbox-dark-hard","gruvbox-dark-medium","gruvbox-dark-soft","gruvbox-light-hard","gruvbox-light-medium","gruvbox-light-soft","houston","kanagawa-dragon","kanagawa-lotus","kanagawa-wave","laserwave","light-plus","material-theme","material-theme-darker","material-theme-lighter","material-theme-ocean","material-theme-palenight","min-dark","min-light","monokai","night-owl","nord","one-dark-pro","one-light","plastic","poimandres","red","rose-pine","rose-pine-dawn","rose-pine-moon","slack-dark","slack-ochin","snazzy-light","solarized-dark","solarized-light","synthwave-84","tokyo-night","vesper","vitesse-black","vitesse-dark","vitesse-light"]},"CustomizationSidebarBackgroundStyle":{"type":"string","description":"- `default`: No background, content sits directly against sidebar edge.\n- `filled`: Muted background color that extends to sidebar edges.\n","enum":["default","filled"]},"CustomizationSidebarListStyle":{"type":"string","description":"- `default`: Simple list items without special styling, groups are inset with a line.\n- `pill`: Rounded capsule shape around selected/active items.\n- `line`: Continuous line next to all items, with colored line part for selected/active items.\n","enum":["default","pill","line"]},"CustomizationSearchStyle":{"type":"string","description":"The style of the search button.\n- `prominent`: large search bar in the middle of the header, with less room for other header items,\n- `subtle`: small search bar in the corner of the header, with more room for other header items.\n","enum":["prominent","subtle"]},"CustomizationLocale":{"type":"string","description":"Language for the UI element","deprecated":true,"enum":["en","fr","es","zh","ja","de","nl","no","pt-br","ru"]},"CustomizationFavicon":{"oneOf":[{"type":"object","properties":{"icon":{"$ref":"#/components/schemas/CustomizationThemedURL"}},"required":["icon"]},{"type":"object","properties":{"emoji":{"$ref":"#/components/schemas/Emoji"}},"required":["emoji"]},{"type":"object","properties":{},"additionalProperties":false}]},"CustomizationThemedURL":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/URL"},"dark":{"$ref":"#/components/schemas/URL"}},"required":["light","dark"]},"Emoji":{"type":"string","maxLength":50,"format":"emoji","description":"Unicode codepoint or character of the emoji"},"CustomizationHeaderPreset":{"type":"string","deprecated":true,"description":"The header preset to use for the site. This is a legacy setting and the site styling theme should be used instead.","enum":["default","bold","contrast","custom","none"]},"ContentRef":{"description":"A relative reference to content in GitBook.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefPage"},{"$ref":"#/components/schemas/ContentRefAnchor"},{"$ref":"#/components/schemas/ContentRefUser"},{"$ref":"#/components/schemas/ContentRefCollection"},{"$ref":"#/components/schemas/ContentRefSpace"},{"$ref":"#/components/schemas/ContentRefReusableContent"},{"$ref":"#/components/schemas/ContentRefOpenAPI"}]},"ContentRefFile":{"type":"object","properties":{"kind":{"type":"string","enum":["file"]},"file":{"type":"string"},"space":{"description":"ID of the space the file is in. The file is considered as in the current space if none is provided.","type":"string"}},"required":["kind","file"]},"ContentRefURL":{"type":"object","properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string"}},"required":["kind","url"]},"ContentRefPage":{"type":"object","properties":{"kind":{"type":"string","enum":["page"]},"page":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"}},"required":["kind","page"]},"ContentRefAnchor":{"type":"object","properties":{"kind":{"type":"string","enum":["anchor"]},"anchor":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"},"page":{"description":"ID of the page the anchor is in. The anchor is considered as in the current page if none is provided.","type":"string"}},"required":["kind","anchor"]},"ContentRefUser":{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user":{"type":"string"}},"required":["kind","user"]},"ContentRefCollection":{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"collection":{"type":"string"}},"required":["kind","collection"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ContentRefReusableContent":{"type":"object","properties":{"kind":{"type":"string","enum":["reusable-content"]},"reusableContent":{"type":"string"},"space":{"type":"string","description":"The space in which the reusable content is defined. If undefined, the reusable content is assumed to be in the same space as the content reference."}},"required":["kind","reusableContent"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"CustomizationHeaderItem":{"type":"object","properties":{"title":{"type":"string"},"style":{"type":"string","enum":["link","button-primary","button-secondary"]},"to":{"oneOf":[{"$ref":"#/components/schemas/ContentRef"},{"type":"string","nullable":true,"enum":[null]}]},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}},"condition":{"description":"Conditional expression used to evaluate whether the header item should be shown to the site's visitor.","$ref":"#/components/schemas/Expression"}},"required":["title","links","to"]},"CustomizationContentLink":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/CustomizationContentLinkTitle"},"to":{"$ref":"#/components/schemas/ContentRef"}},"required":["title","to"]},"CustomizationContentLinkTitle":{"type":"string","maxLength":64},"Expression":{"type":"string","description":"Expression to evaluate","minLength":0,"maxLength":1024},"CustomizationFooterGroup":{"type":"object","properties":{"title":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}}},"required":["title","links"]},"CustomizationAnnouncement":{"type":"object","properties":{"enabled":{"description":"Whether to show the site's announcement.","type":"boolean"},"message":{"$ref":"#/components/schemas/CustomizationAnnouncementMessage"},"link":{"description":"The content or URL the announcement links to when clicked.","$ref":"#/components/schemas/CustomizationContentLink"},"style":{"description":"The style of the announcement. Used to style the banner with the right semantic color and enable/disable features like hiding the banner.","type":"string","enum":["info","warning","danger","success"]}},"required":["enabled","message","style"]},"CustomizationAnnouncementMessage":{"description":"The text content of the announcement.","type":"string","minLength":2,"maxLength":128},"CustomizationThemeMode":{"type":"string","enum":["light","dark"]},"CustomizationAIMode":{"type":"string","enum":["none","search","assistant"]},"CustomizationSuggestedQuestions":{"type":"array","description":"Suggested questions to display at the start of the chosen AI mode.","items":{"$ref":"#/components/schemas/CustomizationSuggestedQuestion"},"maxItems":5},"CustomizationSuggestedQuestion":{"type":"string","minLength":3,"maxLength":64},"SiteExternalLinksTarget":{"type":"string","description":"How external links should open when clicked.\n- `self`: External links open in the current tab.\n- `blank`: External links open in a new browser tab.\n","enum":["self","blank"]},"SiteSocialAccounts":{"type":"array","description":"The social accounts of the site.","items":{"$ref":"#/components/schemas/SiteSocialAccount"},"maxItems":10},"SiteSocialAccount":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/SiteSocialAccountPlatform"},"handle":{"$ref":"#/components/schemas/SiteSocialAccountHandle"},"display":{"type":"object","properties":{"footer":{"type":"boolean","default":true}},"required":["footer"]}},"required":["platform","handle","display"]},"SiteSocialAccountPlatform":{"description":"The platform of the social handle.","type":"string","enum":["twitter","instagram","facebook","linkedin","github","discord","slack","youtube","tiktok","reddit","bluesky","mastodon","threads","medium"]},"SiteSocialAccountHandle":{"description":"A handle on a social platform, without prefixes like the @ symbol.","type":"string","minLength":1,"maxLength":128}},"responses":{"BadRequestError":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","enum":[400]},"message":{"type":"string"}},"required":["code","message"]}}}}}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/customization":{"get":{"operationId":"getSiteCustomizationById","summary":"Get a site customization settings","tags":["site-customization"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteCustomizationUnmasked"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCustomizationSettings"}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}}}}
```

## PUT /orgs/{organizationId}/sites/{siteId}/customization

> Update a site customization settings

```json
{"openapi":"3.0.3","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-customization","description":"Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteCustomizationSettings\" grouped=\"false\" %}\n    The SiteCustomizationSettings object\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"type":"string"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}}},"schemas":{"SiteCustomizationSettings":{"type":"object","properties":{"title":{"description":"Title to use for the published site. If not defined, it'll fallback to the default content title.","$ref":"#/components/schemas/SiteTitle"},"styling":{"type":"object","properties":{"theme":{"$ref":"#/components/schemas/CustomizationTheme"},"primaryColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"tint":{"$ref":"#/components/schemas/CustomizationTint"},"infoColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"successColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"warningColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"dangerColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"corners":{"$ref":"#/components/schemas/CustomizationCorners"},"depth":{"$ref":"#/components/schemas/CustomizationDepth"},"links":{"$ref":"#/components/schemas/CustomizationLinksStyle"},"font":{"$ref":"#/components/schemas/CustomizationFont"},"monospaceFont":{"$ref":"#/components/schemas/CustomizationMonospaceFont"},"background":{"deprecated":true,"$ref":"#/components/schemas/CustomizationBackground"},"icons":{"$ref":"#/components/schemas/CustomizationIconsStyle"},"codeTheme":{"type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"},"openapi":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"}},"required":["default","openapi"]},"sidebar":{"type":"object","properties":{"background":{"$ref":"#/components/schemas/CustomizationSidebarBackgroundStyle"},"list":{"$ref":"#/components/schemas/CustomizationSidebarListStyle"}},"required":["background","list"]},"search":{"$ref":"#/components/schemas/CustomizationSearchStyle"}},"required":["theme","primaryColor","infoColor","successColor","warningColor","dangerColor","corners","depth","links","font","monospaceFont","codeTheme","background","icons","sidebar","search"]},"internationalization":{"type":"object","deprecated":true,"properties":{"locale":{"$ref":"#/components/schemas/CustomizationLocale"}},"required":["locale"]},"favicon":{"$ref":"#/components/schemas/CustomizationFavicon"},"header":{"type":"object","properties":{"preset":{"$ref":"#/components/schemas/CustomizationHeaderPreset"},"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"primaryLink":{"description":"Destination to open when visitors click the site title/logo in the header.","$ref":"#/components/schemas/ContentRef"},"backgroundColor":{"deprecated":true,"description":"Color of the background in the header. This value is now deprecated in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"linkColor":{"deprecated":true,"description":"Color of the links in the header. This value is now deprecated and will be phased out in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationHeaderItem"}}},"required":["preset","links"]},"footer":{"type":"object","properties":{"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationFooterGroup"}},"copyright":{"type":"string","maxLength":300}},"required":["groups"]},"announcement":{"$ref":"#/components/schemas/CustomizationAnnouncement"},"themes":{"description":"Customization options for the dark/light theme modes.\n","type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemeMode"},"toggeable":{"description":"Should the reader be able to switch between dark and light mode","type":"boolean"}},"required":["default","toggeable"]},"pdf":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, PDF export is enabled for the published site."}},"required":["enabled"]},"feedback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, feedback gathering is enabled"}},"required":["enabled"]},"ai":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/CustomizationAIMode"},"suggestions":{"$ref":"#/components/schemas/CustomizationSuggestedQuestions"}},"required":["mode"]},"advancedCustomization":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, Advanced customization is enabled"}},"required":["enabled"]},"git":{"type":"object","properties":{"showEditLink":{"type":"boolean","description":"Whether the published site should show a link to edit the content on the git provider set up in the Git Sync"}},"required":["showEditLink"]},"pageActions":{"type":"object","properties":{"externalAI":{"type":"boolean","description":"Whether actions to open ChatGPT, Anthropic, etc. should be available in the page menu."},"markdown":{"type":"boolean","description":"Whether the copy and open the markdown version of the page should be available in the page menu."},"mcp":{"type":"boolean","description":"Whether an action to connect to the docs using the MCP server should be available in the page menu."}},"required":["externalAI","markdown","mcp"]},"externalLinks":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/SiteExternalLinksTarget"}},"required":["target"]},"pagination":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the pagination navigation should be displayed on pages."}},"required":["enabled"]},"trademark":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the GitBook trademark (\"Powered by GitBook\") should be visible"}},"required":["enabled"]},"privacyPolicy":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialPreview":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialAccounts":{"$ref":"#/components/schemas/SiteSocialAccounts"},"insights":{"type":"object","properties":{"trackingCookie":{"type":"boolean","description":"Whether GitBook identifies the visitor on the site using a cookie.","default":true}},"required":["trackingCookie"]}},"required":["styling","internationalization","favicon","header","footer","themes","pdf","feedback","ai","advancedCustomization","trademark","externalLinks","pagination","pageActions","git","privacyPolicy","socialPreview","socialAccounts","insights"]},"SiteTitle":{"type":"string","description":"Title of the site","minLength":2,"maxLength":128},"CustomizationTheme":{"type":"string","description":"The theme to apply to the site. Supercedes the old header preset themes.\n- `clean`: Modern theme featuring translucency and minimally-styled elements.\n- `muted`: Sophisticated theme with decreased contrast between elements.\n- `bold`: High-impact theme with prominent colors and strong contrasts.\n- `gradient`: Trendy theme featuring colorful gradients and splashes of color.\n","enum":["clean","muted","bold","gradient"]},"CustomizationThemedColor":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/Color"},"dark":{"$ref":"#/components/schemas/Color"}},"required":["light","dark"]},"Color":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$"},"CustomizationTint":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/CustomizationThemedColor"}},"required":["color"]},"CustomizationCorners":{"type":"string","enum":["straight","rounded","circular"]},"CustomizationDepth":{"type":"string","description":"The degree of visual depth (through shadows, gradients and elevation effects) of elements on the site.\n- `subtle`: Subtle shadows and minimal elevation.\n- `flat`: Flat elements, no shadows and no elevation.\n","enum":["subtle","flat"]},"CustomizationLinksStyle":{"type":"string","description":"The style used for regular links in the main content, header and footer. Sidebar items are styled separately.\n- `default`: Links are colored in the primary color and feature an underline in the same color.\n- `accent`: Links are colored the same as body text and feature an underline in the primary color.\n","enum":["default","accent"]},"CustomizationFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultFont":{"type":"string","enum":["ABCFavorit","Inter","Roboto","RobotoSlab","OpenSans","SourceSansPro","Lato","Ubuntu","Raleway","Merriweather","Overpass","NotoSans","IBMPlexSerif","Poppins","FiraSans"]},"CustomizationFontDefinitionInput":{"type":"object","description":"Defines a font family along with its various font-face declarations for use in CSS '@font-face' rules.","properties":{"id":{"type":"string","description":"A globally unique identifier for the font definition."},"custom":{"type":"boolean","description":"Whether the font is a custom font. If false, this font is provided by GitBook."},"fontFamily":{"$ref":"#/components/schemas/FontFamily"},"fontFaces":{"type":"array","description":"A list of font-face definitions, specifying variations such as weight and style.","items":{"$ref":"#/components/schemas/FontFace"},"minItems":1}},"required":["id","custom","fontFamily","fontFaces"]},"FontFamily":{"type":"string","description":"The human-readable font-family name used in CSS (e.g., \"Open Sans\", \"Playfair Display\").","minLength":1,"maxLength":50},"FontFace":{"type":"object","description":"A single font-face declaration specifying the weight and source files for a particular variation of the font.","properties":{"weight":{"$ref":"#/components/schemas/FontWeight"},"sources":{"type":"array","description":"Font source files provided in supported formats (e.g., woff2, woff).","items":{"$ref":"#/components/schemas/FontSource"},"minItems":1}},"required":["weight","sources"]},"FontWeight":{"type":"integer","description":"Numeric representation of the font weight (400=regular, 500=medium, 700=bold, 900=black).","minimum":1,"maximum":1000},"FontSource":{"type":"object","description":"A font file referenced within a font-face declaration, specifying the file's location and format.","properties":{"url":{"description":"The absolute or relative URL pointing to the font file.","$ref":"#/components/schemas/URL"},"format":{"type":"string","description":"The format of the font file. Prefer 'woff2' for modern browsers.","enum":["woff2","woff"]}},"required":["url"]},"URL":{"type":"string","format":"uri","maxLength":2048},"CustomizationMonospaceFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultMonospaceFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultMonospaceFont":{"type":"string","enum":["FiraCode","IBMPlexMono","JetBrainsMono","SourceCodePro","RobotoMono","SpaceMono","DMMono","Inconsolata"]},"CustomizationBackground":{"type":"string","enum":["plain","match"],"deprecated":true,"description":"The background style has been deprecated and will be removed in a future release. Use the `tint` settings instead."},"CustomizationIconsStyle":{"type":"string","enum":["regular","solid","duotone","light","thin"]},"CustomizationThemedCodeTheme":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/CustomizationCodeTheme"},"dark":{"$ref":"#/components/schemas/CustomizationCodeTheme"}},"required":["light","dark"]},"CustomizationCodeTheme":{"type":"string","enum":["default-light","default-dark","monochrome-light","monochrome-dark","andromeeda","aurora-x","ayu-dark","catppuccin-frappe","catppuccin-latte","catppuccin-macchiato","catppuccin-mocha","dark-plus","dracula","dracula-soft","everforest-dark","everforest-light","github-dark","github-dark-default","github-dark-dimmed","github-dark-high-contrast","github-light","github-light-default","github-light-high-contrast","gruvbox-dark-hard","gruvbox-dark-medium","gruvbox-dark-soft","gruvbox-light-hard","gruvbox-light-medium","gruvbox-light-soft","houston","kanagawa-dragon","kanagawa-lotus","kanagawa-wave","laserwave","light-plus","material-theme","material-theme-darker","material-theme-lighter","material-theme-ocean","material-theme-palenight","min-dark","min-light","monokai","night-owl","nord","one-dark-pro","one-light","plastic","poimandres","red","rose-pine","rose-pine-dawn","rose-pine-moon","slack-dark","slack-ochin","snazzy-light","solarized-dark","solarized-light","synthwave-84","tokyo-night","vesper","vitesse-black","vitesse-dark","vitesse-light"]},"CustomizationSidebarBackgroundStyle":{"type":"string","description":"- `default`: No background, content sits directly against sidebar edge.\n- `filled`: Muted background color that extends to sidebar edges.\n","enum":["default","filled"]},"CustomizationSidebarListStyle":{"type":"string","description":"- `default`: Simple list items without special styling, groups are inset with a line.\n- `pill`: Rounded capsule shape around selected/active items.\n- `line`: Continuous line next to all items, with colored line part for selected/active items.\n","enum":["default","pill","line"]},"CustomizationSearchStyle":{"type":"string","description":"The style of the search button.\n- `prominent`: large search bar in the middle of the header, with less room for other header items,\n- `subtle`: small search bar in the corner of the header, with more room for other header items.\n","enum":["prominent","subtle"]},"CustomizationLocale":{"type":"string","description":"Language for the UI element","deprecated":true,"enum":["en","fr","es","zh","ja","de","nl","no","pt-br","ru"]},"CustomizationFavicon":{"oneOf":[{"type":"object","properties":{"icon":{"$ref":"#/components/schemas/CustomizationThemedURL"}},"required":["icon"]},{"type":"object","properties":{"emoji":{"$ref":"#/components/schemas/Emoji"}},"required":["emoji"]},{"type":"object","properties":{},"additionalProperties":false}]},"CustomizationThemedURL":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/URL"},"dark":{"$ref":"#/components/schemas/URL"}},"required":["light","dark"]},"Emoji":{"type":"string","maxLength":50,"format":"emoji","description":"Unicode codepoint or character of the emoji"},"CustomizationHeaderPreset":{"type":"string","deprecated":true,"description":"The header preset to use for the site. This is a legacy setting and the site styling theme should be used instead.","enum":["default","bold","contrast","custom","none"]},"ContentRef":{"description":"A relative reference to content in GitBook.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefPage"},{"$ref":"#/components/schemas/ContentRefAnchor"},{"$ref":"#/components/schemas/ContentRefUser"},{"$ref":"#/components/schemas/ContentRefCollection"},{"$ref":"#/components/schemas/ContentRefSpace"},{"$ref":"#/components/schemas/ContentRefReusableContent"},{"$ref":"#/components/schemas/ContentRefOpenAPI"}]},"ContentRefFile":{"type":"object","properties":{"kind":{"type":"string","enum":["file"]},"file":{"type":"string"},"space":{"description":"ID of the space the file is in. The file is considered as in the current space if none is provided.","type":"string"}},"required":["kind","file"]},"ContentRefURL":{"type":"object","properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string"}},"required":["kind","url"]},"ContentRefPage":{"type":"object","properties":{"kind":{"type":"string","enum":["page"]},"page":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"}},"required":["kind","page"]},"ContentRefAnchor":{"type":"object","properties":{"kind":{"type":"string","enum":["anchor"]},"anchor":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"},"page":{"description":"ID of the page the anchor is in. The anchor is considered as in the current page if none is provided.","type":"string"}},"required":["kind","anchor"]},"ContentRefUser":{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user":{"type":"string"}},"required":["kind","user"]},"ContentRefCollection":{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"collection":{"type":"string"}},"required":["kind","collection"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ContentRefReusableContent":{"type":"object","properties":{"kind":{"type":"string","enum":["reusable-content"]},"reusableContent":{"type":"string"},"space":{"type":"string","description":"The space in which the reusable content is defined. If undefined, the reusable content is assumed to be in the same space as the content reference."}},"required":["kind","reusableContent"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"CustomizationHeaderItem":{"type":"object","properties":{"title":{"type":"string"},"style":{"type":"string","enum":["link","button-primary","button-secondary"]},"to":{"oneOf":[{"$ref":"#/components/schemas/ContentRef"},{"type":"string","nullable":true,"enum":[null]}]},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}},"condition":{"description":"Conditional expression used to evaluate whether the header item should be shown to the site's visitor.","$ref":"#/components/schemas/Expression"}},"required":["title","links","to"]},"CustomizationContentLink":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/CustomizationContentLinkTitle"},"to":{"$ref":"#/components/schemas/ContentRef"}},"required":["title","to"]},"CustomizationContentLinkTitle":{"type":"string","maxLength":64},"Expression":{"type":"string","description":"Expression to evaluate","minLength":0,"maxLength":1024},"CustomizationFooterGroup":{"type":"object","properties":{"title":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}}},"required":["title","links"]},"CustomizationAnnouncement":{"type":"object","properties":{"enabled":{"description":"Whether to show the site's announcement.","type":"boolean"},"message":{"$ref":"#/components/schemas/CustomizationAnnouncementMessage"},"link":{"description":"The content or URL the announcement links to when clicked.","$ref":"#/components/schemas/CustomizationContentLink"},"style":{"description":"The style of the announcement. Used to style the banner with the right semantic color and enable/disable features like hiding the banner.","type":"string","enum":["info","warning","danger","success"]}},"required":["enabled","message","style"]},"CustomizationAnnouncementMessage":{"description":"The text content of the announcement.","type":"string","minLength":2,"maxLength":128},"CustomizationThemeMode":{"type":"string","enum":["light","dark"]},"CustomizationAIMode":{"type":"string","enum":["none","search","assistant"]},"CustomizationSuggestedQuestions":{"type":"array","description":"Suggested questions to display at the start of the chosen AI mode.","items":{"$ref":"#/components/schemas/CustomizationSuggestedQuestion"},"maxItems":5},"CustomizationSuggestedQuestion":{"type":"string","minLength":3,"maxLength":64},"SiteExternalLinksTarget":{"type":"string","description":"How external links should open when clicked.\n- `self`: External links open in the current tab.\n- `blank`: External links open in a new browser tab.\n","enum":["self","blank"]},"SiteSocialAccounts":{"type":"array","description":"The social accounts of the site.","items":{"$ref":"#/components/schemas/SiteSocialAccount"},"maxItems":10},"SiteSocialAccount":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/SiteSocialAccountPlatform"},"handle":{"$ref":"#/components/schemas/SiteSocialAccountHandle"},"display":{"type":"object","properties":{"footer":{"type":"boolean","default":true}},"required":["footer"]}},"required":["platform","handle","display"]},"SiteSocialAccountPlatform":{"description":"The platform of the social handle.","type":"string","enum":["twitter","instagram","facebook","linkedin","github","discord","slack","youtube","tiktok","reddit","bluesky","mastodon","threads","medium"]},"SiteSocialAccountHandle":{"description":"A handle on a social platform, without prefixes like the @ symbol.","type":"string","minLength":1,"maxLength":128}},"responses":{"BadRequestError":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","enum":[400]},"message":{"type":"string"}},"required":["code","message"]}}}}}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/customization":{"put":{"operationId":"updateSiteCustomizationById","summary":"Update a site customization settings","tags":["site-customization"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCustomizationSettings"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCustomizationSettings"}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}}}}
```

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

> Get a site space customization settings

```json
{"openapi":"3.0.3","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-customization","description":"Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteCustomizationSettings\" grouped=\"false\" %}\n    The SiteCustomizationSettings object\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"type":"string"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteSpaceId":{"name":"siteSpaceId","in":"path","required":true,"description":"The unique id of the site-space relationship","schema":{"type":"string"}},"siteCustomizationUnmasked":{"name":"unmasked","in":"query","description":"(Deprecated) Use the getRawCustomizationSettingsById internal endpoint.","deprecated":true,"schema":{"type":"boolean","default":false}}},"schemas":{"SiteCustomizationSettings":{"type":"object","properties":{"title":{"description":"Title to use for the published site. If not defined, it'll fallback to the default content title.","$ref":"#/components/schemas/SiteTitle"},"styling":{"type":"object","properties":{"theme":{"$ref":"#/components/schemas/CustomizationTheme"},"primaryColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"tint":{"$ref":"#/components/schemas/CustomizationTint"},"infoColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"successColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"warningColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"dangerColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"corners":{"$ref":"#/components/schemas/CustomizationCorners"},"depth":{"$ref":"#/components/schemas/CustomizationDepth"},"links":{"$ref":"#/components/schemas/CustomizationLinksStyle"},"font":{"$ref":"#/components/schemas/CustomizationFont"},"monospaceFont":{"$ref":"#/components/schemas/CustomizationMonospaceFont"},"background":{"deprecated":true,"$ref":"#/components/schemas/CustomizationBackground"},"icons":{"$ref":"#/components/schemas/CustomizationIconsStyle"},"codeTheme":{"type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"},"openapi":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"}},"required":["default","openapi"]},"sidebar":{"type":"object","properties":{"background":{"$ref":"#/components/schemas/CustomizationSidebarBackgroundStyle"},"list":{"$ref":"#/components/schemas/CustomizationSidebarListStyle"}},"required":["background","list"]},"search":{"$ref":"#/components/schemas/CustomizationSearchStyle"}},"required":["theme","primaryColor","infoColor","successColor","warningColor","dangerColor","corners","depth","links","font","monospaceFont","codeTheme","background","icons","sidebar","search"]},"internationalization":{"type":"object","deprecated":true,"properties":{"locale":{"$ref":"#/components/schemas/CustomizationLocale"}},"required":["locale"]},"favicon":{"$ref":"#/components/schemas/CustomizationFavicon"},"header":{"type":"object","properties":{"preset":{"$ref":"#/components/schemas/CustomizationHeaderPreset"},"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"primaryLink":{"description":"Destination to open when visitors click the site title/logo in the header.","$ref":"#/components/schemas/ContentRef"},"backgroundColor":{"deprecated":true,"description":"Color of the background in the header. This value is now deprecated in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"linkColor":{"deprecated":true,"description":"Color of the links in the header. This value is now deprecated and will be phased out in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationHeaderItem"}}},"required":["preset","links"]},"footer":{"type":"object","properties":{"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationFooterGroup"}},"copyright":{"type":"string","maxLength":300}},"required":["groups"]},"announcement":{"$ref":"#/components/schemas/CustomizationAnnouncement"},"themes":{"description":"Customization options for the dark/light theme modes.\n","type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemeMode"},"toggeable":{"description":"Should the reader be able to switch between dark and light mode","type":"boolean"}},"required":["default","toggeable"]},"pdf":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, PDF export is enabled for the published site."}},"required":["enabled"]},"feedback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, feedback gathering is enabled"}},"required":["enabled"]},"ai":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/CustomizationAIMode"},"suggestions":{"$ref":"#/components/schemas/CustomizationSuggestedQuestions"}},"required":["mode"]},"advancedCustomization":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, Advanced customization is enabled"}},"required":["enabled"]},"git":{"type":"object","properties":{"showEditLink":{"type":"boolean","description":"Whether the published site should show a link to edit the content on the git provider set up in the Git Sync"}},"required":["showEditLink"]},"pageActions":{"type":"object","properties":{"externalAI":{"type":"boolean","description":"Whether actions to open ChatGPT, Anthropic, etc. should be available in the page menu."},"markdown":{"type":"boolean","description":"Whether the copy and open the markdown version of the page should be available in the page menu."},"mcp":{"type":"boolean","description":"Whether an action to connect to the docs using the MCP server should be available in the page menu."}},"required":["externalAI","markdown","mcp"]},"externalLinks":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/SiteExternalLinksTarget"}},"required":["target"]},"pagination":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the pagination navigation should be displayed on pages."}},"required":["enabled"]},"trademark":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the GitBook trademark (\"Powered by GitBook\") should be visible"}},"required":["enabled"]},"privacyPolicy":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialPreview":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialAccounts":{"$ref":"#/components/schemas/SiteSocialAccounts"},"insights":{"type":"object","properties":{"trackingCookie":{"type":"boolean","description":"Whether GitBook identifies the visitor on the site using a cookie.","default":true}},"required":["trackingCookie"]}},"required":["styling","internationalization","favicon","header","footer","themes","pdf","feedback","ai","advancedCustomization","trademark","externalLinks","pagination","pageActions","git","privacyPolicy","socialPreview","socialAccounts","insights"]},"SiteTitle":{"type":"string","description":"Title of the site","minLength":2,"maxLength":128},"CustomizationTheme":{"type":"string","description":"The theme to apply to the site. Supercedes the old header preset themes.\n- `clean`: Modern theme featuring translucency and minimally-styled elements.\n- `muted`: Sophisticated theme with decreased contrast between elements.\n- `bold`: High-impact theme with prominent colors and strong contrasts.\n- `gradient`: Trendy theme featuring colorful gradients and splashes of color.\n","enum":["clean","muted","bold","gradient"]},"CustomizationThemedColor":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/Color"},"dark":{"$ref":"#/components/schemas/Color"}},"required":["light","dark"]},"Color":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$"},"CustomizationTint":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/CustomizationThemedColor"}},"required":["color"]},"CustomizationCorners":{"type":"string","enum":["straight","rounded","circular"]},"CustomizationDepth":{"type":"string","description":"The degree of visual depth (through shadows, gradients and elevation effects) of elements on the site.\n- `subtle`: Subtle shadows and minimal elevation.\n- `flat`: Flat elements, no shadows and no elevation.\n","enum":["subtle","flat"]},"CustomizationLinksStyle":{"type":"string","description":"The style used for regular links in the main content, header and footer. Sidebar items are styled separately.\n- `default`: Links are colored in the primary color and feature an underline in the same color.\n- `accent`: Links are colored the same as body text and feature an underline in the primary color.\n","enum":["default","accent"]},"CustomizationFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultFont":{"type":"string","enum":["ABCFavorit","Inter","Roboto","RobotoSlab","OpenSans","SourceSansPro","Lato","Ubuntu","Raleway","Merriweather","Overpass","NotoSans","IBMPlexSerif","Poppins","FiraSans"]},"CustomizationFontDefinitionInput":{"type":"object","description":"Defines a font family along with its various font-face declarations for use in CSS '@font-face' rules.","properties":{"id":{"type":"string","description":"A globally unique identifier for the font definition."},"custom":{"type":"boolean","description":"Whether the font is a custom font. If false, this font is provided by GitBook."},"fontFamily":{"$ref":"#/components/schemas/FontFamily"},"fontFaces":{"type":"array","description":"A list of font-face definitions, specifying variations such as weight and style.","items":{"$ref":"#/components/schemas/FontFace"},"minItems":1}},"required":["id","custom","fontFamily","fontFaces"]},"FontFamily":{"type":"string","description":"The human-readable font-family name used in CSS (e.g., \"Open Sans\", \"Playfair Display\").","minLength":1,"maxLength":50},"FontFace":{"type":"object","description":"A single font-face declaration specifying the weight and source files for a particular variation of the font.","properties":{"weight":{"$ref":"#/components/schemas/FontWeight"},"sources":{"type":"array","description":"Font source files provided in supported formats (e.g., woff2, woff).","items":{"$ref":"#/components/schemas/FontSource"},"minItems":1}},"required":["weight","sources"]},"FontWeight":{"type":"integer","description":"Numeric representation of the font weight (400=regular, 500=medium, 700=bold, 900=black).","minimum":1,"maximum":1000},"FontSource":{"type":"object","description":"A font file referenced within a font-face declaration, specifying the file's location and format.","properties":{"url":{"description":"The absolute or relative URL pointing to the font file.","$ref":"#/components/schemas/URL"},"format":{"type":"string","description":"The format of the font file. Prefer 'woff2' for modern browsers.","enum":["woff2","woff"]}},"required":["url"]},"URL":{"type":"string","format":"uri","maxLength":2048},"CustomizationMonospaceFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultMonospaceFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultMonospaceFont":{"type":"string","enum":["FiraCode","IBMPlexMono","JetBrainsMono","SourceCodePro","RobotoMono","SpaceMono","DMMono","Inconsolata"]},"CustomizationBackground":{"type":"string","enum":["plain","match"],"deprecated":true,"description":"The background style has been deprecated and will be removed in a future release. Use the `tint` settings instead."},"CustomizationIconsStyle":{"type":"string","enum":["regular","solid","duotone","light","thin"]},"CustomizationThemedCodeTheme":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/CustomizationCodeTheme"},"dark":{"$ref":"#/components/schemas/CustomizationCodeTheme"}},"required":["light","dark"]},"CustomizationCodeTheme":{"type":"string","enum":["default-light","default-dark","monochrome-light","monochrome-dark","andromeeda","aurora-x","ayu-dark","catppuccin-frappe","catppuccin-latte","catppuccin-macchiato","catppuccin-mocha","dark-plus","dracula","dracula-soft","everforest-dark","everforest-light","github-dark","github-dark-default","github-dark-dimmed","github-dark-high-contrast","github-light","github-light-default","github-light-high-contrast","gruvbox-dark-hard","gruvbox-dark-medium","gruvbox-dark-soft","gruvbox-light-hard","gruvbox-light-medium","gruvbox-light-soft","houston","kanagawa-dragon","kanagawa-lotus","kanagawa-wave","laserwave","light-plus","material-theme","material-theme-darker","material-theme-lighter","material-theme-ocean","material-theme-palenight","min-dark","min-light","monokai","night-owl","nord","one-dark-pro","one-light","plastic","poimandres","red","rose-pine","rose-pine-dawn","rose-pine-moon","slack-dark","slack-ochin","snazzy-light","solarized-dark","solarized-light","synthwave-84","tokyo-night","vesper","vitesse-black","vitesse-dark","vitesse-light"]},"CustomizationSidebarBackgroundStyle":{"type":"string","description":"- `default`: No background, content sits directly against sidebar edge.\n- `filled`: Muted background color that extends to sidebar edges.\n","enum":["default","filled"]},"CustomizationSidebarListStyle":{"type":"string","description":"- `default`: Simple list items without special styling, groups are inset with a line.\n- `pill`: Rounded capsule shape around selected/active items.\n- `line`: Continuous line next to all items, with colored line part for selected/active items.\n","enum":["default","pill","line"]},"CustomizationSearchStyle":{"type":"string","description":"The style of the search button.\n- `prominent`: large search bar in the middle of the header, with less room for other header items,\n- `subtle`: small search bar in the corner of the header, with more room for other header items.\n","enum":["prominent","subtle"]},"CustomizationLocale":{"type":"string","description":"Language for the UI element","deprecated":true,"enum":["en","fr","es","zh","ja","de","nl","no","pt-br","ru"]},"CustomizationFavicon":{"oneOf":[{"type":"object","properties":{"icon":{"$ref":"#/components/schemas/CustomizationThemedURL"}},"required":["icon"]},{"type":"object","properties":{"emoji":{"$ref":"#/components/schemas/Emoji"}},"required":["emoji"]},{"type":"object","properties":{},"additionalProperties":false}]},"CustomizationThemedURL":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/URL"},"dark":{"$ref":"#/components/schemas/URL"}},"required":["light","dark"]},"Emoji":{"type":"string","maxLength":50,"format":"emoji","description":"Unicode codepoint or character of the emoji"},"CustomizationHeaderPreset":{"type":"string","deprecated":true,"description":"The header preset to use for the site. This is a legacy setting and the site styling theme should be used instead.","enum":["default","bold","contrast","custom","none"]},"ContentRef":{"description":"A relative reference to content in GitBook.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefPage"},{"$ref":"#/components/schemas/ContentRefAnchor"},{"$ref":"#/components/schemas/ContentRefUser"},{"$ref":"#/components/schemas/ContentRefCollection"},{"$ref":"#/components/schemas/ContentRefSpace"},{"$ref":"#/components/schemas/ContentRefReusableContent"},{"$ref":"#/components/schemas/ContentRefOpenAPI"}]},"ContentRefFile":{"type":"object","properties":{"kind":{"type":"string","enum":["file"]},"file":{"type":"string"},"space":{"description":"ID of the space the file is in. The file is considered as in the current space if none is provided.","type":"string"}},"required":["kind","file"]},"ContentRefURL":{"type":"object","properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string"}},"required":["kind","url"]},"ContentRefPage":{"type":"object","properties":{"kind":{"type":"string","enum":["page"]},"page":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"}},"required":["kind","page"]},"ContentRefAnchor":{"type":"object","properties":{"kind":{"type":"string","enum":["anchor"]},"anchor":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"},"page":{"description":"ID of the page the anchor is in. The anchor is considered as in the current page if none is provided.","type":"string"}},"required":["kind","anchor"]},"ContentRefUser":{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user":{"type":"string"}},"required":["kind","user"]},"ContentRefCollection":{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"collection":{"type":"string"}},"required":["kind","collection"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ContentRefReusableContent":{"type":"object","properties":{"kind":{"type":"string","enum":["reusable-content"]},"reusableContent":{"type":"string"},"space":{"type":"string","description":"The space in which the reusable content is defined. If undefined, the reusable content is assumed to be in the same space as the content reference."}},"required":["kind","reusableContent"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"CustomizationHeaderItem":{"type":"object","properties":{"title":{"type":"string"},"style":{"type":"string","enum":["link","button-primary","button-secondary"]},"to":{"oneOf":[{"$ref":"#/components/schemas/ContentRef"},{"type":"string","nullable":true,"enum":[null]}]},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}},"condition":{"description":"Conditional expression used to evaluate whether the header item should be shown to the site's visitor.","$ref":"#/components/schemas/Expression"}},"required":["title","links","to"]},"CustomizationContentLink":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/CustomizationContentLinkTitle"},"to":{"$ref":"#/components/schemas/ContentRef"}},"required":["title","to"]},"CustomizationContentLinkTitle":{"type":"string","maxLength":64},"Expression":{"type":"string","description":"Expression to evaluate","minLength":0,"maxLength":1024},"CustomizationFooterGroup":{"type":"object","properties":{"title":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}}},"required":["title","links"]},"CustomizationAnnouncement":{"type":"object","properties":{"enabled":{"description":"Whether to show the site's announcement.","type":"boolean"},"message":{"$ref":"#/components/schemas/CustomizationAnnouncementMessage"},"link":{"description":"The content or URL the announcement links to when clicked.","$ref":"#/components/schemas/CustomizationContentLink"},"style":{"description":"The style of the announcement. Used to style the banner with the right semantic color and enable/disable features like hiding the banner.","type":"string","enum":["info","warning","danger","success"]}},"required":["enabled","message","style"]},"CustomizationAnnouncementMessage":{"description":"The text content of the announcement.","type":"string","minLength":2,"maxLength":128},"CustomizationThemeMode":{"type":"string","enum":["light","dark"]},"CustomizationAIMode":{"type":"string","enum":["none","search","assistant"]},"CustomizationSuggestedQuestions":{"type":"array","description":"Suggested questions to display at the start of the chosen AI mode.","items":{"$ref":"#/components/schemas/CustomizationSuggestedQuestion"},"maxItems":5},"CustomizationSuggestedQuestion":{"type":"string","minLength":3,"maxLength":64},"SiteExternalLinksTarget":{"type":"string","description":"How external links should open when clicked.\n- `self`: External links open in the current tab.\n- `blank`: External links open in a new browser tab.\n","enum":["self","blank"]},"SiteSocialAccounts":{"type":"array","description":"The social accounts of the site.","items":{"$ref":"#/components/schemas/SiteSocialAccount"},"maxItems":10},"SiteSocialAccount":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/SiteSocialAccountPlatform"},"handle":{"$ref":"#/components/schemas/SiteSocialAccountHandle"},"display":{"type":"object","properties":{"footer":{"type":"boolean","default":true}},"required":["footer"]}},"required":["platform","handle","display"]},"SiteSocialAccountPlatform":{"description":"The platform of the social handle.","type":"string","enum":["twitter","instagram","facebook","linkedin","github","discord","slack","youtube","tiktok","reddit","bluesky","mastodon","threads","medium"]},"SiteSocialAccountHandle":{"description":"A handle on a social platform, without prefixes like the @ symbol.","type":"string","minLength":1,"maxLength":128}},"responses":{"BadRequestError":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","enum":[400]},"message":{"type":"string"}},"required":["code","message"]}}}}}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization":{"get":{"operationId":"getSiteSpaceCustomizationById","summary":"Get a site space customization settings","tags":["site-customization"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteSpaceId"},{"$ref":"#/components/parameters/siteCustomizationUnmasked"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCustomizationSettings"}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}}}}
```

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

> Delete a site space customization settings

```json
{"openapi":"3.0.3","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-customization","description":"Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteCustomizationSettings\" grouped=\"false\" %}\n    The SiteCustomizationSettings object\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"type":"string"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteSpaceId":{"name":"siteSpaceId","in":"path","required":true,"description":"The unique id of the site-space relationship","schema":{"type":"string"}}},"responses":{"BadRequestError":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","enum":[400]},"message":{"type":"string"}},"required":["code","message"]}}}}}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization":{"delete":{"operationId":"deleteSiteSpaceCustomizationById","summary":"Delete a site space customization settings","tags":["site-customization"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteSpaceId"}],"responses":{"204":{"description":"Customization settings did not exist"},"205":{"description":"Site space customization removed"},"400":{"$ref":"#/components/responses/BadRequestError"}}}}}}
```

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

> Override a site space customization settings

```json
{"openapi":"3.0.3","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-customization","description":"Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteCustomizationSettings\" grouped=\"false\" %}\n    The SiteCustomizationSettings object\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"type":"string"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteSpaceId":{"name":"siteSpaceId","in":"path","required":true,"description":"The unique id of the site-space relationship","schema":{"type":"string"}}},"schemas":{"SiteTitle":{"type":"string","description":"Title of the site","minLength":2,"maxLength":128},"CustomizationTheme":{"type":"string","description":"The theme to apply to the site. Supercedes the old header preset themes.\n- `clean`: Modern theme featuring translucency and minimally-styled elements.\n- `muted`: Sophisticated theme with decreased contrast between elements.\n- `bold`: High-impact theme with prominent colors and strong contrasts.\n- `gradient`: Trendy theme featuring colorful gradients and splashes of color.\n","enum":["clean","muted","bold","gradient"]},"CustomizationThemedColor":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/Color"},"dark":{"$ref":"#/components/schemas/Color"}},"required":["light","dark"]},"Color":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$"},"CustomizationTint":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/CustomizationThemedColor"}},"required":["color"]},"CustomizationCorners":{"type":"string","enum":["straight","rounded","circular"]},"CustomizationDepth":{"type":"string","description":"The degree of visual depth (through shadows, gradients and elevation effects) of elements on the site.\n- `subtle`: Subtle shadows and minimal elevation.\n- `flat`: Flat elements, no shadows and no elevation.\n","enum":["subtle","flat"]},"CustomizationLinksStyle":{"type":"string","description":"The style used for regular links in the main content, header and footer. Sidebar items are styled separately.\n- `default`: Links are colored in the primary color and feature an underline in the same color.\n- `accent`: Links are colored the same as body text and feature an underline in the primary color.\n","enum":["default","accent"]},"CustomizationIconsStyle":{"type":"string","enum":["regular","solid","duotone","light","thin"]},"CustomizationSidebarBackgroundStyle":{"type":"string","description":"- `default`: No background, content sits directly against sidebar edge.\n- `filled`: Muted background color that extends to sidebar edges.\n","enum":["default","filled"]},"CustomizationSidebarListStyle":{"type":"string","description":"- `default`: Simple list items without special styling, groups are inset with a line.\n- `pill`: Rounded capsule shape around selected/active items.\n- `line`: Continuous line next to all items, with colored line part for selected/active items.\n","enum":["default","pill","line"]},"CustomizationSearchStyle":{"type":"string","description":"The style of the search button.\n- `prominent`: large search bar in the middle of the header, with less room for other header items,\n- `subtle`: small search bar in the corner of the header, with more room for other header items.\n","enum":["prominent","subtle"]},"CustomizationBackground":{"type":"string","enum":["plain","match"],"deprecated":true,"description":"The background style has been deprecated and will be removed in a future release. Use the `tint` settings instead."},"CustomizationThemedCodeTheme":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/CustomizationCodeTheme"},"dark":{"$ref":"#/components/schemas/CustomizationCodeTheme"}},"required":["light","dark"]},"CustomizationCodeTheme":{"type":"string","enum":["default-light","default-dark","monochrome-light","monochrome-dark","andromeeda","aurora-x","ayu-dark","catppuccin-frappe","catppuccin-latte","catppuccin-macchiato","catppuccin-mocha","dark-plus","dracula","dracula-soft","everforest-dark","everforest-light","github-dark","github-dark-default","github-dark-dimmed","github-dark-high-contrast","github-light","github-light-default","github-light-high-contrast","gruvbox-dark-hard","gruvbox-dark-medium","gruvbox-dark-soft","gruvbox-light-hard","gruvbox-light-medium","gruvbox-light-soft","houston","kanagawa-dragon","kanagawa-lotus","kanagawa-wave","laserwave","light-plus","material-theme","material-theme-darker","material-theme-lighter","material-theme-ocean","material-theme-palenight","min-dark","min-light","monokai","night-owl","nord","one-dark-pro","one-light","plastic","poimandres","red","rose-pine","rose-pine-dawn","rose-pine-moon","slack-dark","slack-ochin","snazzy-light","solarized-dark","solarized-light","synthwave-84","tokyo-night","vesper","vitesse-black","vitesse-dark","vitesse-light"]},"CustomizationLocale":{"type":"string","description":"Language for the UI element","deprecated":true,"enum":["en","fr","es","zh","ja","de","nl","no","pt-br","ru"]},"CustomizationFavicon":{"oneOf":[{"type":"object","properties":{"icon":{"$ref":"#/components/schemas/CustomizationThemedURL"}},"required":["icon"]},{"type":"object","properties":{"emoji":{"$ref":"#/components/schemas/Emoji"}},"required":["emoji"]},{"type":"object","properties":{},"additionalProperties":false}]},"CustomizationThemedURL":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/URL"},"dark":{"$ref":"#/components/schemas/URL"}},"required":["light","dark"]},"URL":{"type":"string","format":"uri","maxLength":2048},"Emoji":{"type":"string","maxLength":50,"format":"emoji","description":"Unicode codepoint or character of the emoji"},"CustomizationAnnouncement":{"type":"object","properties":{"enabled":{"description":"Whether to show the site's announcement.","type":"boolean"},"message":{"$ref":"#/components/schemas/CustomizationAnnouncementMessage"},"link":{"description":"The content or URL the announcement links to when clicked.","$ref":"#/components/schemas/CustomizationContentLink"},"style":{"description":"The style of the announcement. Used to style the banner with the right semantic color and enable/disable features like hiding the banner.","type":"string","enum":["info","warning","danger","success"]}},"required":["enabled","message","style"]},"CustomizationAnnouncementMessage":{"description":"The text content of the announcement.","type":"string","minLength":2,"maxLength":128},"CustomizationContentLink":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/CustomizationContentLinkTitle"},"to":{"$ref":"#/components/schemas/ContentRef"}},"required":["title","to"]},"CustomizationContentLinkTitle":{"type":"string","maxLength":64},"ContentRef":{"description":"A relative reference to content in GitBook.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefPage"},{"$ref":"#/components/schemas/ContentRefAnchor"},{"$ref":"#/components/schemas/ContentRefUser"},{"$ref":"#/components/schemas/ContentRefCollection"},{"$ref":"#/components/schemas/ContentRefSpace"},{"$ref":"#/components/schemas/ContentRefReusableContent"},{"$ref":"#/components/schemas/ContentRefOpenAPI"}]},"ContentRefFile":{"type":"object","properties":{"kind":{"type":"string","enum":["file"]},"file":{"type":"string"},"space":{"description":"ID of the space the file is in. The file is considered as in the current space if none is provided.","type":"string"}},"required":["kind","file"]},"ContentRefURL":{"type":"object","properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string"}},"required":["kind","url"]},"ContentRefPage":{"type":"object","properties":{"kind":{"type":"string","enum":["page"]},"page":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"}},"required":["kind","page"]},"ContentRefAnchor":{"type":"object","properties":{"kind":{"type":"string","enum":["anchor"]},"anchor":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"},"page":{"description":"ID of the page the anchor is in. The anchor is considered as in the current page if none is provided.","type":"string"}},"required":["kind","anchor"]},"ContentRefUser":{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user":{"type":"string"}},"required":["kind","user"]},"ContentRefCollection":{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"collection":{"type":"string"}},"required":["kind","collection"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ContentRefReusableContent":{"type":"object","properties":{"kind":{"type":"string","enum":["reusable-content"]},"reusableContent":{"type":"string"},"space":{"type":"string","description":"The space in which the reusable content is defined. If undefined, the reusable content is assumed to be in the same space as the content reference."}},"required":["kind","reusableContent"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"CustomizationHeaderPreset":{"type":"string","deprecated":true,"description":"The header preset to use for the site. This is a legacy setting and the site styling theme should be used instead.","enum":["default","bold","contrast","custom","none"]},"CustomizationHeaderItem":{"type":"object","properties":{"title":{"type":"string"},"style":{"type":"string","enum":["link","button-primary","button-secondary"]},"to":{"oneOf":[{"$ref":"#/components/schemas/ContentRef"},{"type":"string","nullable":true,"enum":[null]}]},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}},"condition":{"description":"Conditional expression used to evaluate whether the header item should be shown to the site's visitor.","$ref":"#/components/schemas/Expression"}},"required":["title","links","to"]},"Expression":{"type":"string","description":"Expression to evaluate","minLength":0,"maxLength":1024},"CustomizationFooterGroup":{"type":"object","properties":{"title":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationContentLink"}}},"required":["title","links"]},"CustomizationThemeMode":{"type":"string","enum":["light","dark"]},"SiteExternalLinksTarget":{"type":"string","description":"How external links should open when clicked.\n- `self`: External links open in the current tab.\n- `blank`: External links open in a new browser tab.\n","enum":["self","blank"]},"SiteCustomizationSettings":{"type":"object","properties":{"title":{"description":"Title to use for the published site. If not defined, it'll fallback to the default content title.","$ref":"#/components/schemas/SiteTitle"},"styling":{"type":"object","properties":{"theme":{"$ref":"#/components/schemas/CustomizationTheme"},"primaryColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"tint":{"$ref":"#/components/schemas/CustomizationTint"},"infoColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"successColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"warningColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"dangerColor":{"$ref":"#/components/schemas/CustomizationThemedColor"},"corners":{"$ref":"#/components/schemas/CustomizationCorners"},"depth":{"$ref":"#/components/schemas/CustomizationDepth"},"links":{"$ref":"#/components/schemas/CustomizationLinksStyle"},"font":{"$ref":"#/components/schemas/CustomizationFont"},"monospaceFont":{"$ref":"#/components/schemas/CustomizationMonospaceFont"},"background":{"deprecated":true,"$ref":"#/components/schemas/CustomizationBackground"},"icons":{"$ref":"#/components/schemas/CustomizationIconsStyle"},"codeTheme":{"type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"},"openapi":{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"}},"required":["default","openapi"]},"sidebar":{"type":"object","properties":{"background":{"$ref":"#/components/schemas/CustomizationSidebarBackgroundStyle"},"list":{"$ref":"#/components/schemas/CustomizationSidebarListStyle"}},"required":["background","list"]},"search":{"$ref":"#/components/schemas/CustomizationSearchStyle"}},"required":["theme","primaryColor","infoColor","successColor","warningColor","dangerColor","corners","depth","links","font","monospaceFont","codeTheme","background","icons","sidebar","search"]},"internationalization":{"type":"object","deprecated":true,"properties":{"locale":{"$ref":"#/components/schemas/CustomizationLocale"}},"required":["locale"]},"favicon":{"$ref":"#/components/schemas/CustomizationFavicon"},"header":{"type":"object","properties":{"preset":{"$ref":"#/components/schemas/CustomizationHeaderPreset"},"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"primaryLink":{"description":"Destination to open when visitors click the site title/logo in the header.","$ref":"#/components/schemas/ContentRef"},"backgroundColor":{"deprecated":true,"description":"Color of the background in the header. This value is now deprecated in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"linkColor":{"deprecated":true,"description":"Color of the links in the header. This value is now deprecated and will be phased out in favour of the new theming colors.","$ref":"#/components/schemas/CustomizationThemedColor"},"links":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationHeaderItem"}}},"required":["preset","links"]},"footer":{"type":"object","properties":{"logo":{"$ref":"#/components/schemas/CustomizationThemedURL"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationFooterGroup"}},"copyright":{"type":"string","maxLength":300}},"required":["groups"]},"announcement":{"$ref":"#/components/schemas/CustomizationAnnouncement"},"themes":{"description":"Customization options for the dark/light theme modes.\n","type":"object","properties":{"default":{"$ref":"#/components/schemas/CustomizationThemeMode"},"toggeable":{"description":"Should the reader be able to switch between dark and light mode","type":"boolean"}},"required":["default","toggeable"]},"pdf":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, PDF export is enabled for the published site."}},"required":["enabled"]},"feedback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, feedback gathering is enabled"}},"required":["enabled"]},"ai":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/CustomizationAIMode"},"suggestions":{"$ref":"#/components/schemas/CustomizationSuggestedQuestions"}},"required":["mode"]},"advancedCustomization":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, Advanced customization is enabled"}},"required":["enabled"]},"git":{"type":"object","properties":{"showEditLink":{"type":"boolean","description":"Whether the published site should show a link to edit the content on the git provider set up in the Git Sync"}},"required":["showEditLink"]},"pageActions":{"type":"object","properties":{"externalAI":{"type":"boolean","description":"Whether actions to open ChatGPT, Anthropic, etc. should be available in the page menu."},"markdown":{"type":"boolean","description":"Whether the copy and open the markdown version of the page should be available in the page menu."},"mcp":{"type":"boolean","description":"Whether an action to connect to the docs using the MCP server should be available in the page menu."}},"required":["externalAI","markdown","mcp"]},"externalLinks":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/SiteExternalLinksTarget"}},"required":["target"]},"pagination":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the pagination navigation should be displayed on pages."}},"required":["enabled"]},"trademark":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the GitBook trademark (\"Powered by GitBook\") should be visible"}},"required":["enabled"]},"privacyPolicy":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialPreview":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/URL"}}},"socialAccounts":{"$ref":"#/components/schemas/SiteSocialAccounts"},"insights":{"type":"object","properties":{"trackingCookie":{"type":"boolean","description":"Whether GitBook identifies the visitor on the site using a cookie.","default":true}},"required":["trackingCookie"]}},"required":["styling","internationalization","favicon","header","footer","themes","pdf","feedback","ai","advancedCustomization","trademark","externalLinks","pagination","pageActions","git","privacyPolicy","socialPreview","socialAccounts","insights"]},"CustomizationFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultFont":{"type":"string","enum":["ABCFavorit","Inter","Roboto","RobotoSlab","OpenSans","SourceSansPro","Lato","Ubuntu","Raleway","Merriweather","Overpass","NotoSans","IBMPlexSerif","Poppins","FiraSans"]},"CustomizationFontDefinitionInput":{"type":"object","description":"Defines a font family along with its various font-face declarations for use in CSS '@font-face' rules.","properties":{"id":{"type":"string","description":"A globally unique identifier for the font definition."},"custom":{"type":"boolean","description":"Whether the font is a custom font. If false, this font is provided by GitBook."},"fontFamily":{"$ref":"#/components/schemas/FontFamily"},"fontFaces":{"type":"array","description":"A list of font-face definitions, specifying variations such as weight and style.","items":{"$ref":"#/components/schemas/FontFace"},"minItems":1}},"required":["id","custom","fontFamily","fontFaces"]},"FontFamily":{"type":"string","description":"The human-readable font-family name used in CSS (e.g., \"Open Sans\", \"Playfair Display\").","minLength":1,"maxLength":50},"FontFace":{"type":"object","description":"A single font-face declaration specifying the weight and source files for a particular variation of the font.","properties":{"weight":{"$ref":"#/components/schemas/FontWeight"},"sources":{"type":"array","description":"Font source files provided in supported formats (e.g., woff2, woff).","items":{"$ref":"#/components/schemas/FontSource"},"minItems":1}},"required":["weight","sources"]},"FontWeight":{"type":"integer","description":"Numeric representation of the font weight (400=regular, 500=medium, 700=bold, 900=black).","minimum":1,"maximum":1000},"FontSource":{"type":"object","description":"A font file referenced within a font-face declaration, specifying the file's location and format.","properties":{"url":{"description":"The absolute or relative URL pointing to the font file.","$ref":"#/components/schemas/URL"},"format":{"type":"string","description":"The format of the font file. Prefer 'woff2' for modern browsers.","enum":["woff2","woff"]}},"required":["url"]},"CustomizationMonospaceFont":{"oneOf":[{"$ref":"#/components/schemas/CustomizationDefaultMonospaceFont"},{"$ref":"#/components/schemas/CustomizationFontDefinitionInput"}]},"CustomizationDefaultMonospaceFont":{"type":"string","enum":["FiraCode","IBMPlexMono","JetBrainsMono","SourceCodePro","RobotoMono","SpaceMono","DMMono","Inconsolata"]},"CustomizationAIMode":{"type":"string","enum":["none","search","assistant"]},"CustomizationSuggestedQuestions":{"type":"array","description":"Suggested questions to display at the start of the chosen AI mode.","items":{"$ref":"#/components/schemas/CustomizationSuggestedQuestion"},"maxItems":5},"CustomizationSuggestedQuestion":{"type":"string","minLength":3,"maxLength":64},"SiteSocialAccounts":{"type":"array","description":"The social accounts of the site.","items":{"$ref":"#/components/schemas/SiteSocialAccount"},"maxItems":10},"SiteSocialAccount":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/SiteSocialAccountPlatform"},"handle":{"$ref":"#/components/schemas/SiteSocialAccountHandle"},"display":{"type":"object","properties":{"footer":{"type":"boolean","default":true}},"required":["footer"]}},"required":["platform","handle","display"]},"SiteSocialAccountPlatform":{"description":"The platform of the social handle.","type":"string","enum":["twitter","instagram","facebook","linkedin","github","discord","slack","youtube","tiktok","reddit","bluesky","mastodon","threads","medium"]},"SiteSocialAccountHandle":{"description":"A handle on a social platform, without prefixes like the @ symbol.","type":"string","minLength":1,"maxLength":128}},"responses":{"BadRequestError":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","enum":[400]},"message":{"type":"string"}},"required":["code","message"]}}}}}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization":{"patch":{"operationId":"overrideSiteSpaceCustomizationById","summary":"Override a site space customization settings","tags":["site-customization"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteSpaceId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"The settings that overrides the site customization settings.","type":"object","properties":{"title":{"description":"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.","oneOf":[{"$ref":"#/components/schemas/SiteTitle"},{"type":"string","nullable":true,"enum":[null]}]},"styling":{"type":"object","properties":{"theme":{"description":"The site theme. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationTheme"},{"type":"string","nullable":true,"enum":[null]}]},"primaryColor":{"description":"The primary color used for links and UI text. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedColor"},{"type":"string","nullable":true,"enum":[null]}]},"infoColor":{"description":"Used for informational messages and neutral alerts. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedColor"},{"type":"string","nullable":true,"enum":[null]}]},"successColor":{"description":"Used for showing positive actions or achievements. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedColor"},{"type":"string","nullable":true,"enum":[null]}]},"warningColor":{"description":"Used for showing important information or non-critical warnings. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedColor"},{"type":"string","nullable":true,"enum":[null]}]},"dangerColor":{"description":"Used for destructive actions or raising attention to critical information. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedColor"},{"type":"string","nullable":true,"enum":[null]}]},"tint":{"description":"The tint will color the site’s UI beyond links and buttons, such as header, sidebar and background. By default, the tint colour is the same as your Primary colour, but you can set a custom one too.","oneOf":[{"$ref":"#/components/schemas/CustomizationTint"},{"type":"string","nullable":true,"enum":[null]}]},"corners":{"description":"The style of the corners to use. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationCorners"},{"type":"string","nullable":true,"enum":[null]}]},"depth":{"description":"The depth of elements on the site. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationDepth"},{"type":"string","nullable":true,"enum":[null]}]},"links":{"description":"The style for links to use. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationLinksStyle"},{"type":"string","nullable":true,"enum":[null]}]},"icons":{"description":"The icons style to use for the content. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationIconsStyle"},{"type":"string","nullable":true,"enum":[null]}]},"sidebar":{"description":"Various styles for the sidebar. Each can be Set to null to reset the override.","type":"object","properties":{"background":{"oneOf":[{"$ref":"#/components/schemas/CustomizationSidebarBackgroundStyle"},{"type":"string","nullable":true,"enum":[null]}]},"list":{"oneOf":[{"$ref":"#/components/schemas/CustomizationSidebarListStyle"},{"type":"string","nullable":true,"enum":[null]}]}}},"search":{"description":"Styling for the search button at the top of the site.","oneOf":[{"$ref":"#/components/schemas/CustomizationSearchStyle"},{"type":"string","nullable":true,"enum":[null]}]},"background":{"description":"The style of background to use. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationBackground"},{"type":"string","nullable":true,"enum":[null]}]},"codeTheme":{"description":"The code theme to use. Set to null to reset the override.","type":"object","properties":{"default":{"oneOf":[{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"},{"type":"string","nullable":true,"enum":[null]}]},"openapi":{"oneOf":[{"$ref":"#/components/schemas/CustomizationThemedCodeTheme"},{"type":"string","nullable":true,"enum":[null]}]}}}}},"internationalization":{"type":"object","deprecated":true,"properties":{"locale":{"description":"The locale to use for the non-custom elements of the UI. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationLocale"},{"type":"string","nullable":true,"enum":[null]}]}},"required":["locale"]},"favicon":{"description":"The favicon to use. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationFavicon"},{"type":"string","nullable":true,"enum":[null]}]},"announcement":{"$ref":"#/components/schemas/CustomizationAnnouncement"},"header":{"type":"object","properties":{"preset":{"description":"The theme preset to use. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationHeaderPreset"},{"type":"string","nullable":true,"enum":[null]}]},"logo":{"description":"The header logo to use. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedURL"},{"type":"string","nullable":true,"enum":[null]}]},"primaryLink":{"description":"The destination to open when visitors click the site title/logo in the header. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/ContentRef"},{"type":"string","nullable":true,"enum":[null]}]},"backgroundColor":{"description":"The background color used in the header. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedColor"},{"type":"string","nullable":true,"enum":[null]}]},"linkColor":{"description":"The color used by the links in the header. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedColor"},{"type":"string","nullable":true,"enum":[null]}]},"links":{"type":"array","description":"The links that are displayed in the header. Set to null to reset the override.","nullable":true,"items":{"$ref":"#/components/schemas/CustomizationHeaderItem"}}}},"footer":{"type":"object","properties":{"logo":{"description":"The logo displayed in the footer. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemedURL"},{"type":"string","nullable":true,"enum":[null]}]},"groups":{"type":"array","description":"The links groups that are displayed in the footer. Set to null to reset the override.","nullable":true,"items":{"$ref":"#/components/schemas/CustomizationFooterGroup"}},"copyright":{"type":"string","description":"The copyright text that is displayed in the footer. Set to null to reset the override.","nullable":true,"maxLength":300}}},"themes":{"type":"object","properties":{"default":{"description":"The theme mode default value. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/CustomizationThemeMode"},{"type":"string","nullable":true,"enum":[null]}]},"toggeable":{"description":"Should the reader be able to switch between dark and light mode. Set to null to reset the override.","type":"boolean","nullable":true}}},"pdf":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, PDF export is enabled for the published site. Set to null to reset the override.","nullable":true}},"required":["enabled"]},"feedback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, feedback gathering is enabled. Set to null to reset the override.","nullable":true}},"required":["enabled"]},"git":{"type":"object","properties":{"showEditLink":{"type":"boolean","description":"Whether the published site should show a link to edit the content on the git provider set up in the Git Sync. Set to null to reset the override.","nullable":true}},"required":["showEditLink"]},"externalLinks":{"type":"object","properties":{"target":{"description":"How external links should open. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/SiteExternalLinksTarget"},{"type":"string","nullable":true,"enum":[null]}]}},"required":["target"]},"pagination":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the pagination navigation should be displayed on pages. Set to null to reset the override.","nullable":true}},"required":["enabled"]},"trademark":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the GitBook trademark (\"Powered by GitBook\") should be visible. Set to null to reset the override.","nullable":true}},"required":["enabled"]},"privacyPolicy":{"type":"object","properties":{"url":{"description":"The custom link to the privacy policy. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/URL"},{"type":"string","nullable":true,"enum":[null]}]}}},"socialPreview":{"type":"object","properties":{"url":{"description":"The URL for the social preview image. Set to null to reset the override.","oneOf":[{"$ref":"#/components/schemas/URL"},{"type":"string","nullable":true,"enum":[null]}]}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCustomizationSettings"}}}},"400":{"$ref":"#/components/responses/BadRequestError"}}}}}}
```