Update a topic

patch

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

siteTopicIdstringRequired

The unique id of the topic

Body

application/json

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

idstringRequired

The ID of the topic

labelstringRequired

The label of the topic

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

iconstring · icon · max: 50Required

Name of the icon

Example: gear

pagesnumberRequired

The number of pages associated with the topic

recordsnumberRequired

The number of records in the topic

patch/orgs/{organizationId}/sites/{siteId}/topics/{siteTopicId}

HTTPcURLJavaScriptPython

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

{
  "usageSettings": {
    "changeRequests": true
  }
}

200

OK

{
  "object": "context-topic",
  "id": "text",
  "label": "text",
  "parent": {
    "id": "text",
    "label": "text"
  },
  "createdAt": "2026-07-21T22:26:29.964Z",
  "updatedAt": "2026-07-21T22:26:29.964Z",
  "icon": "gear",
  "summary": {
    "object": "document",
    "data": {},
    "nodes": [
      {
        "object": "block",
        "type": "paragraph",
        "data": {},
        "nodes": [
          {
            "object": "text",
            "leaves": [
              {
                "object": "leaf",
                "text": "Hello world",
                "marks": []
              }
            ]
          }
        ]
      }
    ]
  },
  "usageSettings": {
    "changeRequests": true
  },
  "pages": 1,
  "records": 1,
  "findings": {
    "open": 1,
    "total": 1
  },
  "questions": {
    "total": 1,
    "answers": 1,
    "feedback": {
      "positive": 1,
      "negative": 1,
      "unrated": 1
    },
    "answered": {
      "yes": 1,
      "partially": 1,
      "no": 1
    },
    "relevance": {
      "relevant": 1,
      "spam": 1,
      "off-topic": 1,
      "unclear": 1
    },
    "types": {
      "exploring": 1,
      "how-to": 1,
      "troubleshooting": 1,
      "reference": 1,
      "unknown": 1
    },
    "channelTypes": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "channels": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "weeklyPulse": [
      1
    ]
  },
  "urls": {
    "location": "https://example.com"
  }
}