Update a site finding

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

siteFindingIdstringRequired

The unique id of the site finding

Body

application/json

statusstring · enumRequired

Status of a site finding.

• candidate is a finding that has been raised but not yet confirmed. Typically these are not shown to users.
• open is a finding that has been surfaced to users and is still under investigation.
• done is a finding that has been resolved and is no longer under investigation.
• canceled is a finding that has been canceled and is no longer under investigation.

Possible values:

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

idstringRequired

The ID of the finding

scanstringRequired

The site scan ID associated with the finding

topicstring · nullableRequired

The site topic ID associated with the finding. It is null for findings that are not associated with a current topic in the site.

titlestring · max: 256Required

Short finding title

changeRequestsnumberRequired

Number of change requests linked to the finding

pagesnumberRequired

Number of pages linked to the finding

recordsnumberRequired

Number of records linked to the finding

questionsnumberRequired

Number of questions linked to the finding

statusstring · enumRequired

Status of a site finding.

• candidate is a finding that has been raised but not yet confirmed. Typically these are not shown to users.
• open is a finding that has been surfaced to users and is still under investigation.
• done is a finding that has been resolved and is no longer under investigation.
• canceled is a finding that has been canceled and is no longer under investigation.

Possible values:

typestring · enumRequired

Classification of a site finding:

• Outdated content: The content was correct but is no longer up to date with external context and may be misleading or incorrect.
• Incorrect content: The content is factually wrong or misleading, leading users astray regardless of whether it was ever correct.
• Content gap: The content is missing important information that should be present to answer user questions effectively.
• Other: Any other type of finding not covered by the above categories.

Possible values:

severitystring · enumRequired

Estimated end-user severity of a site finding.

Possible values:

autoFixablebooleanRequired

Whether an AI agent should be able to fix this finding directly

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

patch/orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}

HTTPcURLJavaScriptPython

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

{
  "status": "candidate"
}

200

OK

{
  "object": "site-finding",
  "id": "text",
  "scan": "text",
  "topic": null,
  "title": "text",
  "changeRequests": 1,
  "pages": 1,
  "records": 1,
  "questions": 1,
  "status": "candidate",
  "type": "content-outdated",
  "severity": "low",
  "description": {
    "object": "document",
    "data": {},
    "nodes": [
      {
        "object": "block",
        "type": "paragraph",
        "data": {},
        "nodes": [
          {
            "object": "text",
            "leaves": [
              {
                "object": "leaf",
                "text": "Hello world",
                "marks": []
              }
            ]
          }
        ]
      }
    ]
  },
  "autoFixable": true,
  "createdAt": "2026-07-21T22:21:29.866Z",
  "updatedAt": "2026-07-21T22:21:29.866Z",
  "urls": {
    "location": "https://example.com"
  }
}