Skip to main content
POST
Promote Competitor Suggestion

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard (Settings > API keys).

Headers

authorization
string | null

Bearer <api_key>

X-MCP-Secret
string | null

Path Parameters

suggestion_id
integer
required

Query Parameters

website_id
integer
required

Target website id

Body

application/json

Two mutually-exclusive ways to promote a suggestion:

  1. Create a new Competitor (url required, optional logo_url + aliases). The Competitor model has a NOT NULL UNIQUE url column, so a brand-new competitor needs one.
  2. Link the suggestion to an already-tracked Competitor as an alias (link_to_competitor_id required). The suggestion's display name is appended to the target competitor's aliases array, and the suggestion's historical citation attribution is rerouted to that existing competitor — no new row is created.

Exactly one of the two modes must be supplied.

url
string | null
Required string length: 1 - 2048
logo_url
string | null
Maximum string length: 2048
aliases
string[] | null
Required range: x >= 1

Response

Successful Response

Competitor schema without logo

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