Update a section group in a site's navigation structure

Updates a section group's properties in the site's navigation structure.

Available in MCP

patch

Authorizations

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

siteSectionGroupIdstringRequired

The unique id of the site group

Header parameters

preferstring · enumOptional

Control whether a successful response includes the updated resource representation.

Possible values:

Body

titlestring · min: 1 · max: 100Optional

Title of the site section group

conditionstring · max: 1024 · nullableOptional

Conditional expression used to evaluate whether the site section group 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 group should be kept in draft mode. Setting it to true makes the site section group draft. Setting it to false makes the site section group live.

parentSectionGroupIdstring · nullableOptional

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

Responses

200

OK

application/json

objectstring · enumRequired

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

Possible values:

idstringRequired

Unique identifier of the site section group

titlestring · min: 1 · max: 100Required

Title of the site section group

conditionstring · max: 1024Optional

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

sectionGroupstringOptional

ID of the parent section group this group belongs to

draftbooleanRequired

Whether the site section group is draft and not live.

iconstring · icon · max: 50Optional

Name of the icon

Example: gear

204

Site section group updated without returning its representation

patch/orgs/{organizationId}/sites/{siteId}/section-groups/{siteSectionGroupId}

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

{
  "title": "text",
  "localizedTitle": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "condition": "text",
  "icon": "gear",
  "draft": true,
  "parentSectionGroupId": "text"
}

{
  "object": "site-section-group",
  "id": "text",
  "title": "text",
  "localizedTitle": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "condition": "text",
  "sectionGroup": "text",
  "draft": true,
  "children": [
    {
      "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-01-01T00:00:00.000Z",
            "updatedAt": "2026-01-01T00:00:00.000Z",
            "deletedAt": "2026-01-01T00:00:00.000Z",
            "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",
              "parentInstallationId": "text",
              "url": "text",
              "installationProjectDirectory": "text",
              "operation": {
                "state": "running",
                "direction": "export",
                "startedAt": "2026-01-01T00:00:00.000Z",
                "endedAt": "2026-01-01T00:00:00.000Z",
                "error": "text",
                "errorAction": {
                  "label": "text",
                  "url": "https://example.com"
                }
              },
              "operationTimeout": 1,
              "updatedAt": "2026-01-01T00:00:00.000Z"
            },
            "previousGitSync": {
              "url": "text"
            },
            "imports": [
              {
                "object": "import-run",
                "id": "text",
                "startedAt": "2026-01-01T00:00:00.000Z",
                "completedAt": "2026-01-01T00:00:00.000Z",
                "createdAt": "2026-01-01T00:00:00.000Z",
                "updatedAt": "2026-01-01T00:00:00.000Z",
                "status": "pending",
                "reason": "text",
                "source": {
                  "type": "website",
                  "url": "https://example.com"
                },
                "target": {
                  "space": "text",
                  "changeRequest": "text",
                  "page": "text"
                },
                "site": "text",
                "createdBy": "text",
                "urls": {
                  "location": "https://example.com"
                },
                "pages": [
                  {
                    "id": "text",
                    "sourceURL": "text",
                    "type": "page",
                    "status": "complete"
                  }
                ]
              }
            ],
            "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",
          "pageId": "text",
          "draft": true,
          "hasAdvancedCustomizationFeature": true,
          "urls": {
            "published": "https://example.com"
          },
          "hidden": true
        }
      ],
      "urls": {
        "published": "https://example.com"
      },
      "icon": "gear"
    }
  ],
  "icon": "gear"
}