Sign in
latestOpenAPI 3.1.02026-08-204087139.4 KB

c4fe20c603a3

Create Competitor

Create a new competitor

post/brands/{brand_id}/competitors

Path parameters

brand_idinteger required

Request body

namestring required

Display name of the competitor.

alternative_namesstring[]

Alternative names or aliases for the competitor.

excluded_namesstring[]

Phrases that must never count as a mention of this competitor, e.g. a competitor 'Caliber' excluding 'Caliber Auto Wash'.

websitesstring[]

Website URLs associated with the competitor.

case_sensitiveboolean

When true, name and alternative_names are matched against AI responses with exact case. Defaults to case-insensitive matching.

Response

Successful Response

idinteger required
namestring required
alternative_namesstring[]
excluded_namesstring[]
websitesstring[]
case_sensitiveboolean