API reference / Brain
Change a competitor
Changes the name of a competitor, how the business differs from it, or whether the Competitor watcher checks it. Send only what changes.
patch
/api/v1/brand/competitors/{id}Other ways to call it
CLI
troopy brand competitor-setMCP tool
troopy_update_competitorRate limit60 calls in 60 seconds, for each key
Path parameters
id*stringA 24-character id
Body
application/jsonnamestringAt least 1 characters · At most 80 characters
notestring | nullHow the business differs from it. null removes it
watchbooleanResponse
200 · application/jsondata*object7 properties
id*stringA 24-character id
name*stringsite*stringIts domain, like rival.com. Teammates may read its pages, and never type on them
note*string | nullHow the business differs from it, in one line
watch*booleanWhether the Competitor watcher checks it each week
by*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringat*stringISO 8601 date and time
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.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
429 rate_limitedWait the number of seconds in Retry-After, then retry.