Skip to main content
POST
/
api
/
v1
/
public
/
competitors
/
suggestions
/
{suggestion_id}
/
promote
Promote Competitor Suggestion
curl --request POST \
  --url https://api.tryhikoo.com/api/v1/public/competitors/suggestions/{suggestion_id}/promote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "logo_url": "<string>",
  "aliases": [
    "<string>"
  ],
  "link_to_competitor_id": 2
}
'
{
  "id": 123,
  "name": "<string>",
  "url": "<string>",
  "aliases": [
    "<string>"
  ]
}

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
​
link_to_competitor_id
integer | null
Required range: x >= 1

Response

Successful Response

Competitor schema without logo

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