/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Dismiss Documentation Gap

Dismiss Documentation Gap

Mark a documentation gap as handled so it leaves the open list.

POST/v1/projects/{projectId}/analytics/gaps/{gapId}/dismissTry it
Session token

Marks one of the project's documentation gaps as handled. It leaves List Gaps, the AI insights unresolvedIntents and the content health gaps, and Syntext records who dismissed it and when.

Note

Session JWT and org membership required. Any role can dismiss a gap — an API key gets 401, a non-member 403. Any plan.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.
gapId:stringpathRequired
The gap's id from List Gaps. Each gap's dismissUrl is this endpoint's path, ready to call.

No request body.

Response — 200 OK

Dismissing a gap that is already dismissed also returns 200 and changes nothing.

A dismissed gap is not deleted. If visitors ask the same question again, it reopens with fresh counts — frequency starts at 1 and createdAt is the moment it reopened — and the dismissal is cleared.

Error Responses

401 Unauthorized

Missing, invalid or expired session JWT, or an API key.

403 Forbidden

You are not a member of the organization that owns the project.

404 Not Found

The project does not exist, or there is no such gap in this project — including an ID that is not a UUID and a gap that belongs to another project:

json
{
"error": {
"code": "not_found",
"message": "Documentation gap not found",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X POST https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/analytics/gaps/0c8e4a7d-2b1f-4e3a-9d6c-5f7a8b9c0d12/dismiss \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": { "dismissed": true }
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext