Move a site section to a new position. (Deprecated) use sortSiteStructure instead.

Deprecated

post

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

Responses

200

Site section moved

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

400

Invalid move site section position provided

application/json

404

No matching Site section found

application/json

post/orgs/{organizationId}/sites/{siteId}/sections/{siteSectionId}/move

HTTPcURLJavaScriptPython

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

{
  "position": {
    "before": {
      "type": "site-section",
      "siteSection": "text"
    },
    "after": {
      "type": "site-section",
      "siteSection": "text"
    }
  }
}

{
  "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:38:29.266Z",
        "updatedAt": "2026-07-21T22:38:29.266Z",
        "deletedAt": "2026-07-21T22:38:29.266Z",
        "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:38:29.266Z"
        },
        "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"
}