Skip to main content
POST
Add a competitor

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard under Settings > API keys.

Query Parameters

website_id
integer
required

Target website id

Body

application/json
name
string
required
url
string
required
logo_url
string | null
aliases
string[] | null
Maximum array length: 50
Required string length: 1 - 100
url_aliases
string[] | null
Maximum array length: 50
Required string length: 1 - 100

Response

Successful Response

id
integer
required
name
string
required
url
string
required
aliases
string[] | null
url_aliases
string[] | null