Site customization
Customize the look and feel of your docs site.
Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more.
Attributes
titlestring · min: 2 · max: 128Optional
Title to use for the published site. If not defined, it'll fallback to the default content title.
faviconone ofRequired
or
or
objectOptional
The SiteCustomizationSettings object
{
"title": "text",
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"font": "ABCFavorit",
"monospaceFont": "FiraCode",
"icons": "regular",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
},
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent"
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"announcement": {
"enabled": true,
"message": "text",
"link": {
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"themes": {
"default": "light",
"toggeable": true
},
"pdf": {
"enabled": true
},
"feedback": {
"enabled": true
},
"ai": {
"mode": "none",
"suggestions": [
"text"
]
},
"advancedCustomization": {
"enabled": true
},
"git": {
"showEditLink": true
},
"pageActions": {
"externalAI": true,
"markdown": true,
"mcp": true
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
},
"socialAccounts": [
{
"platform": "twitter",
"handle": "text",
"display": {
"footer": true
}
}
],
"insights": {
"trackingCookie": true
}
}Authorizations
Path parameters
organizationIdstringRequired
The unique id of the organization
siteIdstringRequired
The unique id of the site
Query parameters
unmaskedbooleanOptionalDeprecatedDefault:
(Deprecated) Use the getRawCustomizationSettingsById internal endpoint.
falseResponses
200
OK
application/json
400
Bad Request
application/json
get
GET /v1/orgs/{organizationId}/sites/{siteId}/customization HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"title": "text",
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"font": "ABCFavorit",
"monospaceFont": "FiraCode",
"icons": "regular",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
},
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent"
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"announcement": {
"enabled": true,
"message": "text",
"link": {
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"themes": {
"default": "light",
"toggeable": true
},
"pdf": {
"enabled": true
},
"feedback": {
"enabled": true
},
"ai": {
"mode": "none",
"suggestions": [
"text"
]
},
"advancedCustomization": {
"enabled": true
},
"git": {
"showEditLink": true
},
"pageActions": {
"externalAI": true,
"markdown": true,
"mcp": true
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
},
"socialAccounts": [
{
"platform": "twitter",
"handle": "text",
"display": {
"footer": true
}
}
],
"insights": {
"trackingCookie": true
}
}Authorizations
Path parameters
organizationIdstringRequired
The unique id of the organization
siteIdstringRequired
The unique id of the site
Body
titlestring · min: 2 · max: 128Optional
Title to use for the published site. If not defined, it'll fallback to the default content title.
faviconone ofRequired
or
or
objectOptional
Responses
200
OK
application/json
400
Bad Request
application/json
put
PUT /v1/orgs/{organizationId}/sites/{siteId}/customization HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1966
{
"title": "text",
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"font": "ABCFavorit",
"monospaceFont": "FiraCode",
"icons": "regular",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
},
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent"
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"announcement": {
"enabled": true,
"message": "text",
"link": {
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"themes": {
"default": "light",
"toggeable": true
},
"pdf": {
"enabled": true
},
"feedback": {
"enabled": true
},
"ai": {
"mode": "none",
"suggestions": [
"text"
]
},
"advancedCustomization": {
"enabled": true
},
"git": {
"showEditLink": true
},
"pageActions": {
"externalAI": true,
"markdown": true,
"mcp": true
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
},
"socialAccounts": [
{
"platform": "twitter",
"handle": "text",
"display": {
"footer": true
}
}
],
"insights": {
"trackingCookie": true
}
}{
"title": "text",
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"font": "ABCFavorit",
"monospaceFont": "FiraCode",
"icons": "regular",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
},
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent"
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"announcement": {
"enabled": true,
"message": "text",
"link": {
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"themes": {
"default": "light",
"toggeable": true
},
"pdf": {
"enabled": true
},
"feedback": {
"enabled": true
},
"ai": {
"mode": "none",
"suggestions": [
"text"
]
},
"advancedCustomization": {
"enabled": true
},
"git": {
"showEditLink": true
},
"pageActions": {
"externalAI": true,
"markdown": true,
"mcp": true
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
},
"socialAccounts": [
{
"platform": "twitter",
"handle": "text",
"display": {
"footer": true
}
}
],
"insights": {
"trackingCookie": true
}
}Authorizations
Path parameters
organizationIdstringRequired
The unique id of the organization
siteIdstringRequired
The unique id of the site
siteSpaceIdstringRequired
The unique id of the site-space relationship
Query parameters
unmaskedbooleanOptionalDeprecatedDefault:
(Deprecated) Use the getRawCustomizationSettingsById internal endpoint.
falseResponses
200
OK
application/json
400
Bad Request
application/json
get
GET /v1/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"title": "text",
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"font": "ABCFavorit",
"monospaceFont": "FiraCode",
"icons": "regular",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
},
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent"
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"announcement": {
"enabled": true,
"message": "text",
"link": {
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"themes": {
"default": "light",
"toggeable": true
},
"pdf": {
"enabled": true
},
"feedback": {
"enabled": true
},
"ai": {
"mode": "none",
"suggestions": [
"text"
]
},
"advancedCustomization": {
"enabled": true
},
"git": {
"showEditLink": true
},
"pageActions": {
"externalAI": true,
"markdown": true,
"mcp": true
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
},
"socialAccounts": [
{
"platform": "twitter",
"handle": "text",
"display": {
"footer": true
}
}
],
"insights": {
"trackingCookie": true
}
}Authorizations
Path parameters
organizationIdstringRequired
The unique id of the organization
siteIdstringRequired
The unique id of the site
siteSpaceIdstringRequired
The unique id of the site-space relationship
Responses
204
Customization settings did not exist
205
Site space customization removed
400
Bad Request
application/json
delete
DELETE /v1/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Authorizations
Path parameters
organizationIdstringRequired
The unique id of the organization
siteIdstringRequired
The unique id of the site
siteSpaceIdstringRequired
The unique id of the site-space relationship
Body
The settings that overrides the site customization settings.
titleone ofOptional
Title to use for the published site variant. If not defined, the title will not be changed. If set to null, the title will be unset and will fallback to the content title.
string · min: 2 · max: 128Optional
Title of the site
string · enum | nullableOptionalPossible values:
faviconone ofOptional
The favicon to use. Set to null to reset the override.
or
or
objectOptional
string · enum | nullableOptionalPossible values:
Responses
200
OK
application/json
400
Bad Request
application/json
patch
PATCH /v1/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/customization HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1746
{
"title": "text",
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"icons": "regular",
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
}
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"announcement": {
"enabled": true,
"message": "text",
"link": {
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"backgroundColor": {
"light": "text",
"dark": "text"
},
"linkColor": {
"light": "text",
"dark": "text"
},
"links": [
{
"title": "text",
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"themes": {
"default": "light",
"toggeable": true
},
"pdf": {
"enabled": true
},
"feedback": {
"enabled": true
},
"git": {
"showEditLink": true
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
}
}{
"title": "text",
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"font": "ABCFavorit",
"monospaceFont": "FiraCode",
"icons": "regular",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
},
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent"
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"links": [
{
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"announcement": {
"enabled": true,
"message": "text",
"link": {
"title": "text",
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"themes": {
"default": "light",
"toggeable": true
},
"pdf": {
"enabled": true
},
"feedback": {
"enabled": true
},
"ai": {
"mode": "none",
"suggestions": [
"text"
]
},
"advancedCustomization": {
"enabled": true
},
"git": {
"showEditLink": true
},
"pageActions": {
"externalAI": true,
"markdown": true,
"mcp": true
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
},
"socialAccounts": [
{
"platform": "twitter",
"handle": "text",
"display": {
"footer": true
}
}
],
"insights": {
"trackingCookie": true
}
}Last updated
Was this helpful?