Move a site space 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

siteSpaceIdstringRequired

The unique id of the site-space relationship

Body

application/json

Responses

200

Site space moved

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.

pageIdstring · nullableOptional

Custom home page within the space, rendered at the site space's path root instead of the space's default landing page.

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.

400

Invalid move site space position provided

application/json

404

No matching Site space found

application/json

post/orgs/{organizationId}/sites/{siteId}/site-spaces/{siteSpaceId}/move

HTTPcURLJavaScriptPython

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

{
  "position": {
    "before": {
      "type": "site-space",
      "siteSpace": "text"
    },
    "after": {
      "type": "site-space",
      "siteSpace": "text"
    }
  }
}

{
  "object": "site-space",
  "id": "text",
  "path": "text",
  "section": "text",
  "space": {
    "object": "space",
    "id": "text",
    "title": "text",
    "emoji": "🎉",
    "visibility": "public",
    "createdAt": "2026-08-11T01:03:55.457Z",
    "updatedAt": "2026-08-11T01:03:55.457Z",
    "deletedAt": "2026-08-11T01:03:55.457Z",
    "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",
      "operation": {
        "state": "running",
        "direction": "export",
        "startedAt": "2026-08-11T01:03:55.457Z",
        "endedAt": "2026-08-11T01:03:55.457Z",
        "error": "text"
      },
      "updatedAt": "2026-08-11T01:03:55.457Z"
    },
    "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
}