API reference / Brain
Suggest a competitor
Suggests a competitor for a person to add. It waits under Suggested in Brain > Brand > Competitors, and counts only after a person adds it. The site of the business, a site that it has as a competitor, a site that a person dismissed, and a site that many businesses share are refused. 20 suggestions wait at most.
/api/v1/brand/competitors/suggestionsOther ways to call it
troopy brand competitor-suggesttroopy_suggest_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 its site writes 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
why*stringWhy it competes with the business, in one or two sentences: whom it sells to, and what
At least 1 characters · At most 300 characters
Response
201 · application/jsondata*object6 properties
id*stringA 24-character id
name*stringsite*stringwhy*stringWhy the teammate thinks that it competes, in the teammate's words
by*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringat*stringISO 8601 date and time