Update an integration space installation

patch

Authorizations

useruser-internaluser-staffintegrationintegration-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

spaceIdstringRequired

A unique entity identifier

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

Query parameters

extendedbooleanOptional

If true, returns the space object in each items. If false, returns the space ID in each items.

Default: false

Body

application/json

externalIdsstring[] · max: 5Optional

External IDs assigned by the integration.

Responses

200

The space installation has been updated.

application/json

Base properties of an installation of an integration on a site or space.

integrationstringRequired

Unique name identifier of the integration

installationstringRequired

ID of the integration installation

statusstring · enumRequiredPossible values:

configurationobjectRequired

Configuration of the integration for this site

externalIdsstring[] · max: 5Required

External IDs assigned by the integration.

spaceone ofRequired

The space the integration is installed on. Using the string value is deprecated in favor of space.id

stringOptional

or

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

HTTPcURLJavaScriptPython

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

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

200

The space installation has been updated.

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com",
    "publicContentEndpoint": "https://example.com"
  },
  "space": "text"
}