/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Update Slack Bot Settings

Update Slack Bot Settings

Change how the Slack bot replies: in threads, with sources, and whether unanswered questions become documentation gaps.

PATCH/v1/projects/{projectId}/addons/slack_bot/settingsTry it
Session token

Changes how the project's Slack bot behaves. Send only the settings you want to change; the others keep their values.

Note

Requires the admin or owner role. A member gets 403 forbidden ("Only workspace admins can change Slack bot settings.") with details.requiredRole: "admin". Needs a session JWT — an API key gets 401. Any member can read the settings with Get Slack Bot Status.

Starter plan or higher. Lower plans get 402 plan_required with feature: slack_bot — see Plan errors.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Request Body

At least one of the following. No other fields are allowed. All three default to true, which is how the bot behaved before these settings existed.

NameDescription
replyInThread:booleanbody
true: answer a message that mentions the bot in a thread under it. false: answer in the channel. A question asked inside an existing thread is always answered in that thread.
showSources:booleanbody
Append the list of docs pages the answer drew on.
flagUnanswered:booleanbody
Record a question the bot answered without any source as a documentation gap.

Response — 200 OK

All three settings after the change:

The bot uses the new settings from its next message. The saved bot token and signing secret are not touched.

Error Responses

400 Bad Request

The body is empty, has a field other than the three settings, or a value that is not a boolean:

json
{
"error": {
"code": "validation_error",
"message": "Send one or more of replyInThread, showSources, flagUnanswered as booleans",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}

401 Unauthorized

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

402 Payment Required

The workspace is on Free:

json
{
"error": {
"code": "plan_required",
"message": "The Slack bot requires the Starter plan or higher. This workspace is on Free.",
"details": {
"feature": "slack_bot",
"requiredTier": "starter",
"currentTier": "free",
"traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10"
}
}
}

403 Forbidden

You are a member, not an admin or owner (details.requiredRole: "admin"), or not a member of the organization that owns the project.

404 Not Found

The project does not exist, or the Slack bot has never been set up for it (not_found, "The Slack bot is not set up for this project").

Checks run in this order: role, then the body, then the plan, then whether Slack is set up.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X PATCH https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/addons/slack_bot/settings \
-H "Authorization: Bearer $SYNTEXT_JWT" \
-H "Content-Type: application/json" \
-d '{ "replyInThread": false }'
Responseapplication/json
200OK
{
"data": {
"replyInThread": false,
"showSources": true,
"flagUnanswered": true
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext