Update a navigation section in a site

Updates a navigation section's configuration in the site structure.

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

siteSectionIdstringRequired

The unique id of the section within a site

Body

application/json

titlestring · min: 2 · max: 128Optional

Title of the site section

pathstring · min: 1 · max: 100Optional

Path to the section on the site

defaultSiteSpacestringOptional

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

conditionstring · max: 1024 · nullableOptional

Conditional expression used to evaluate whether the site section 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.

iconstring · icon · max: 50 · nullableOptional

Name of the icon

Example: gear

draftbooleanOptional

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

descriptionstring · max: 256 · nullableOptional

Description of the site section

siteSectionGroupIdstring · nullableOptional

ID of the section group to move the section into. Set to null to move the section to the root of the site.

Responses

200

OK

application/json

objectstring · enumRequired

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

Possible values:

idstringRequired

Unique identifier of the site section

titlestring · min: 2 · max: 128Required

Title of the site section

descriptionstring · max: 256Optional

Description of the site section

defaultbooleanOptional

Whether this is the default section for the site

draftbooleanRequired

Whether the site section is draft and not live.

pathstring · min: 1 · max: 100Required

Path to the section on the site

conditionstring · max: 1024Optional

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

sectionGroupstringOptional

ID of the section group the section belongs to in the site

iconstring · icon · max: 50Optional

Name of the icon

Example: gear

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

HTTPcURLJavaScriptPython

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

{
  "title": "text",
  "localizedTitle": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "path": "text",
  "defaultSiteSpace": "text",
  "condition": "text",
  "icon": "gear",
  "draft": true,
  "description": "text",
  "localizedDescription": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "siteSectionGroupId": "text"
}

200

OK

{
  "object": "site-section",
  "id": "text",
  "title": "text",
  "localizedTitle": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "description": "text",
  "localizedDescription": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "default": true,
  "draft": true,
  "path": "text",
  "condition": "text",
  "sectionGroup": "text",
  "siteSpaces": [
    {
      "object": "site-space",
      "id": "text",
      "path": "text",
      "section": "text",
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-07-21T22:06:18.179Z",
        "updatedAt": "2026-07-21T22:06:18.179Z",
        "deletedAt": "2026-07-21T22:06:18.179Z",
        "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-21T22:06:18.179Z"
        },
        "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
    }
  ],
  "urls": {
    "published": "https://example.com"
  },
  "icon": "gear"
}