Update the properties of a documentation site

Updates a documentation site's configuration. Use this to rename a site, change its access level, or point it at a reverse-proxy path such as https://company.com/docs.

Available in MCP

patch

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 of the site

visibilitystring · enumOptional

The visibility setting of the site determines the audience of the site.

• public: Anyone can access the site, and the site is indexed by search engines.
• unlisted: Anyone can access the site, and the site is not indexed by search engines
• share-link: Anyone with a secret token in the url can access the site.
• visitor-auth: Anyone authenticated through a JWT token can access the site.

Possible values:

basenamestring · min: 1 · max: 100Optional

Basename for the site. For e.g. api

defaultLevelone ofOptional

Default level for a piece of content

string · enumOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:

or

nullOptional

or

string · enumOptionalPossible values:

defaultSiteSpacestringOptional

ID of the site-space to be used as the default at the root level. If site has sections, this will mark the default site space in the site's default section.

defaultSiteSectionstringOptional

ID of the site-section to be used as the default.

proxystring · max: 512 · nullableOptional

Configure a proxy URL for a site. For example, you can use it to host the site on a subdirectory of your domain like https://company.com/docs. Use null to remove the proxy.

Pattern: ^([\w-]+\.)*[\w-]+\.[a-zA-Z]{2,}(\/[\w-]+)+$

styleguidestring · nullableOptional

Attach an existing styleguide to the site by the ID of the styleguide space, or null to detach the current one. The space must be a styleguide owned by the same organization.

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

idstringRequired

Unique identifier of the site

typestring · enumRequired

The type of the site

Possible values:

appliedTypestring · enumRequired

The currently applied type of the site. For example, frozen sites will have this set to Basic.

Possible values:

titlestring · min: 2 · max: 128Required

Title of the site

iconone of · nullableOptional

or

or

objectOptional

hostnamestring · max: 512Optional

Custom hostname for the site, for e.g. docs.mycompany.com

Pattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.]){2,}[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$

basenamestring · min: 1 · max: 100Optional

Basename for the site. For e.g. api

visibilitystring · enumRequired

The visibility setting of the site determines the audience of the site.

• public: Anyone can access the site, and the site is indexed by search engines.
• unlisted: Anyone can access the site, and the site is not indexed by search engines
• share-link: Anyone with a secret token in the url can access the site.
• visitor-auth: Anyone authenticated through a JWT token can access the site.

Possible values:

defaultLevelone ofRequired

Default level for a piece of content

string · enumOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:

or

nullOptional

or

string · enumOptionalPossible values:

publishedbooleanRequired

Whether the site is live or not. If true, the site is accessible to the audience defined by the visibility setting.

siteSpacesnumberRequired

createdAtstring · date-timeRequired

adsone ofOptional

or

or

or

patch/orgs/{organizationId}/sites/{siteId}

HTTPcURLJavaScriptPython

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

{
  "title": "text",
  "visibility": "public",
  "basename": "text",
  "adaptiveContent": {
    "enabled": true
  },
  "defaultLevel": "admin",
  "defaultSiteSpace": "text",
  "defaultSiteSection": "text",
  "proxy": "text",
  "styleguide": "text"
}

200

OK

{
  "object": "site",
  "id": "text",
  "type": "basic",
  "appliedType": "basic",
  "title": "text",
  "icon": {
    "icon": {
      "light": "https://example.com",
      "dark": "https://example.com"
    }
  },
  "hostname": "text",
  "basename": "text",
  "proxy": {
    "origin": "text",
    "target": "text"
  },
  "visibility": "public",
  "defaultLevel": "admin",
  "permissions": {
    "view": true,
    "access": true,
    "admin": true,
    "installIntegration": true,
    "viewAdaptiveSchema": true,
    "editAdaptiveSchema": true
  },
  "published": true,
  "siteSpaces": 1,
  "gitSync": {
    "repoName": "text",
    "installationStatus": "unauthenticated",
    "installationProvider": "github",
    "installationId": "text",
    "url": "text",
    "operation": {
      "state": "running"
    },
    "updatedAt": "2026-07-21T20:33:39.841Z"
  },
  "createdAt": "2026-07-21T20:33:39.841Z",
  "adaptiveContent": {
    "enabled": true
  },
  "ads": {
    "status": "pending",
    "submittable": true
  },
  "styleguide": {
    "kind": "space",
    "space": "text"
  },
  "features": [
    {
      "id": "sites-adaptive-content",
      "plan": "basic",
      "frozen": true,
      "customizations": [
        "header-logo"
      ]
    }
  ],
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "published": "https://example.com",
    "preview": "https://example.com",
    "login": "https://example.com",
    "logout": "https://example.com"
  }
}