API reference / Brain
Add a competitor
Adds a competitor of the business. Teammates may read the pages of its site, and never type on them. The Competitor watcher checks it each week while watch is on. Its own site, a site that it has already, and a site that many businesses share (such as facebook.com) are refused. A workspace keeps 30 competitors. A suggestion with the same site goes from the suggestions.
/api/v1/brand/competitorsOther ways to call it
troopy brand competitor-addtroopy_add_competitorIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonname*stringIts name, as people say it
At least 1 characters · At most 80 characters
site*stringIts website or its domain, like rival.com
At least 3 characters · At most 300 characters
notestringHow the business differs from it, in one line
At least 1 characters · At most 160 characters
watchbooleanWhether the Competitor watcher checks it each week. On at first
Response
201 · 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