Update a context connection

patch

Authorizations

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

siteContextConnectionIdstringRequired

The unique id of the context connection

Body

anyOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

200

OK

application/json

and

anyOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

patch/orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId}

PATCH /v1/orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "connector": "builtin:email"
}

200

OK

{
  "object": "context-connection",
  "id": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "syncedAt": "2026-01-01T00:00:00.000Z",
  "label": "text",
  "filter": "text",
  "status": "pending",
  "records": 1,
  "failureMessage": "text",
  "failureReason": "authentication",
  "email": {
    "ingestionAddress": "[e-mail]"
  },
  "usageSettings": {
    "changeRequests": true,
    "search": true,
    "sync": true,
    "searchBoost": "x0.8"
  },
  "urls": {
    "location": "https://example.com"
  },
  "connector": "builtin:email"
}