Skip to main content
POST
Create Competitor

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

Body

application/json

Input model for creating a competitor.

name
string
required

Display name of the competitor.

Minimum string length: 1
alternative_names
string[]

Alternative names or aliases for the competitor.

websites
string<uri>[]

Website URLs associated with the competitor.

Required string length: 1 - 2083
case_sensitive
boolean
default:false

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

Response

Successful Response

id
integer
required
name
string
required
alternative_names
string[]
websites
string[]
case_sensitive
boolean
default:false