Update an integration installation

patch

Authorizations

userintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

installationIdstringRequired

Identifier of the installation

Body

application/json

externalIdsstring[] · max: 5Optional

External IDs assigned by the integration.

space_selectionstring · enumOptional

Describe whether all spaces have been selected or there's a selection involved

Possible values:

site_selectionstring · enumOptional

Describe whether all sites have been selected or there's a selection involved

Possible values:

Responses

200

The installation has been updated.

application/json

Installation of an integration on an account

idstringRequired

statusstring · enumRequiredPossible values:

space_selectionstring · enumRequired

Describe whether all spaces have been selected or there's a selection involved

Possible values:

site_selectionstring · enumRequired

Describe whether all sites have been selected or there's a selection involved

Possible values:

spacesnumberRequired

Count of spaces, the installation is managing

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

externalIdsstring[] · max: 5Required

External IDs assigned by the integration.

targetone ofRequired

Target of the integration installation

patch/integrations/{integrationName}/installations/{installationId}

HTTPcURLJavaScriptPython

PATCH /v1/integrations/{integrationName}/installations/{installationId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "externalIds": [
    "text"
  ],
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "space_selection": "all",
  "site_selection": "all"
}

200

The installation has been updated.

{
  "id": "text",
  "status": "active",
  "space_selection": "all",
  "site_selection": "all",
  "spaces": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2026-07-22T22:58:16.119Z",
  "updatedAt": "2026-07-22T22:58:16.119Z",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "publicEndpoint": "https://example.com",
    "publicContentEndpoint": "https://example.com"
  },
  "externalIds": [
    "text"
  ],
  "target": {
    "organization": "text"
  },
  "network": {
    "proxy": true
  }
}