Skip to main content
TroopyDocs
GuidesSet up and use TroopyAppsConnect your servicesAPIThe API, the CLI and MCPChangelogEach update to Troopy

Developers

Account

Troop

Skills

Tasks and projects

Needs you

Routines and triggers

Brain

Docs

Canvas

Email

CRM

Outreach

Customers

Analytics

Sessions

Surveys

Support Agent

Tests and incidents

Disputes

Apps

Vault

Computer

Open Troopy
Troopy

API reference / Tests and incidents

Change the settings of Tests

Changes the settings that you send, and keeps the others. Owners and admins.

patch/api/v1/test-settings

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.
Scopestests:write

Other ways to call it

CLItroopy tests update-settings
MCP toolNone. Call it over REST or with the CLI.
Rate limit30 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Body

application/json
prCommentsboolean

Whether the QA tester and Troopy's code review comment their reports of a ticket on the pull request: private repos only

autoTicketsboolean

Whether a place whose scheduled checks begin to fail gets a bug ticket in the backlog. While that ticket is open, new failures go on it as comments

keepChecksboolean

Whether the checks of a released ticket become a proposed test of the library

releaseChecksboolean

Whether Troopy checks Production after each release, once the release reaches Production on GitHub: the main path, and the released tickets' tests

Response

200 · application/json
data*object
4 properties
prComments*boolean

Whether the QA tester and Troopy's code review comment their reports of a ticket on the pull request: private repos only

autoTickets*boolean

Whether a place whose scheduled checks begin to fail gets a bug ticket in the backlog. While that ticket is open, new failures go on it as comments

keepChecks*boolean

Whether the checks of a released ticket become a proposed test of the library

releaseChecks*boolean

Whether Troopy checks Production after each release, once the release reaches Production on GitHub: the main path, and the released tickets' tests

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.