Update a space linked to a site

Updates the configuration of a site space. Use this to remap a site space to a different space, hide it from navigation, or promote it from draft to live.

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

siteSpaceIdstringRequired

The unique id of the site-space relationship

Body

application/json

pathstring · min: 1 · max: 100Optional

Path to the space on the site

conditionstring · max: 1024 · nullableOptional

Conditional expression used to evaluate whether the site space should be shown to the site's visitor (should evaluate to a boolean). If not set, the condition will remain unchanged. If set to null, the condition will be removed.

spaceIdstringOptional

The content that this site space points to. If not set, the space will remain unchanged.

hiddenbooleanOptional

Whether the site space is hidden. If true, the site space will not be shown in the site's navigation. If not set, the hidden state will remain unchanged. If set to false, the site space will be shown in site navigation.

draftbooleanOptional

Whether the site space should be kept in draft mode. Setting it to true makes the site space draft. Setting it to false makes the site space live.

Responses

200

OK

application/json

objectstring · enumRequired

The object type, which is always "site-space"

Possible values:

idstringRequired

Unique identifier of the site-space

pathstring · min: 1 · max: 100Required

Path to the space on the site

sectionstringOptional

ID of the section the space belongs to in the site

titlestringRequired

defaultbooleanOptional

Whether this is the default space for the site

conditionstring · max: 1024Optional

Conditional expression used to evaluate whether the site space should be shown to the site's visitor.

draftbooleanRequired

Whether the site space is draft and not live.

hasAdvancedCustomizationFeaturebooleanOptional

Whether the space has advanced customization feature enabled

hiddenbooleanOptional

Whether the site space is hidden. If true, the site space will not be shown in the site's navigation.

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

HTTPcURLJavaScriptPython

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

{
  "path": "text",
  "condition": "text",
  "spaceId": "text",
  "hidden": true,
  "draft": true
}

200

OK

{
  "object": "site-space",
  "id": "text",
  "path": "text",
  "section": "text",
  "space": {
    "object": "space",
    "id": "text",
    "title": "text",
    "emoji": "🎉",
    "visibility": "public",
    "createdAt": "2026-07-22T00:45:17.162Z",
    "updatedAt": "2026-07-22T00:45:17.162Z",
    "deletedAt": "2026-07-22T00:45:17.162Z",
    "editMode": "live",
    "type": "styleguide",
    "mergeRules": {
      "type": "inherit"
    },
    "urls": {
      "location": "https://example.com",
      "app": "https://example.com",
      "published": "https://example.com",
      "public": "https://example.com",
      "icon": "https://example.com"
    },
    "organization": "text",
    "parent": "text",
    "language": "en",
    "gitSync": {
      "repoName": "text",
      "installationStatus": "unauthenticated",
      "installationProvider": "github",
      "installationId": "text",
      "url": "text",
      "operation": {
        "state": "running"
      },
      "updatedAt": "2026-07-22T00:45:17.162Z"
    },
    "visitorAuth": {
      "backend": "custom"
    },
    "revision": "text",
    "defaultLevel": "admin",
    "comments": 1,
    "changeRequests": 1,
    "changeRequestsOpen": 1,
    "changeRequestsDraft": 1,
    "internal_poweredByV2": true,
    "internal_singleWebsocket": true,
    "permissions": {
      "view": true,
      "access": true,
      "admin": true,
      "viewInviteLinks": true,
      "edit": true,
      "triggerGitSync": true,
      "comment": true,
      "merge": true,
      "review": true,
      "installIntegration": true
    }
  },
  "title": "text",
  "localizedTitle": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "default": true,
  "condition": "text",
  "draft": true,
  "hasAdvancedCustomizationFeature": true,
  "urls": {
    "published": "https://example.com"
  },
  "hidden": true
}