Update an integration site installation
Updates the configuration of an integration for one site.
Name of the integration.
^[a-zA-Z0-9-_.]+$Identifier of the installation
The unique id of the site
If true, returns the site object in each items. If false, returns the site ID in each items.
falseExternal IDs assigned by the integration.
ID of a consumed OAuth transaction for this exact target, authorizing a credential write. Single use.
The site installation has been updated.
Base properties of an installation of an integration on a site or space.
Unique name identifier of the integration
ID of the integration installation
Configuration for this site or space. For user authentication, oauth_credentials is returned as a boolean connection indicator. Send true when saving to preserve the connection, or omit the field to clear it. Only the integration or the matching installation can read or set OAuth credentials.
External IDs assigned by the integration.
The site the integration is installed on. Using the string value is deprecated in favor of site.id
PATCH /v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"externalIds": [
"text"
],
"configuration": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"oauthTransaction": "text"
}The site 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"
},
"site": "text"
}Last updated
Was this helpful?