Update the branding and visual customization settings for a site

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

Available in MCP

put

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

Body

application/json

titlestring · min: 2 · max: 128Optional

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

faviconone ofRequired

or

or

objectOptional

Responses

200

OK

application/json

titlestring · min: 2 · max: 128Optional

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

faviconone ofRequired

or

or

objectOptional

updatedAtstring · date-timeOptional

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

400

Bad Request

application/json

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

HTTPcURLJavaScriptPython

PUT /v1/orgs/{organizationId}/sites/{siteId}/customization HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2273

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

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