Skip to main content
PUT
/
api
/
v1
/
public
/
prompts
/
{prompt_id}
Update Prompt
curl --request PUT \
  --url https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "topic_id": 123,
  "localizations": [
    "<string>"
  ],
  "source_keyword": "<string>"
}
'
{
  "id": 123,
  "content": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "topic_id": 123,
  "topic_name": "<string>",
  "localizations": [
    "worldwide"
  ],
  "source_keyword": "<string>",
  "visibility_score": 0,
  "visibility_delta_7d": 123,
  "status": "unclaimed",
  "top_platforms": [],
  "sentiment_score": 123,
  "sentiment_highlights_count": 0,
  "sentiment_positive_count": 0,
  "sentiment_negative_count": 0,
  "sentiment_neutral_count": 0,
  "ai_search_volume": 123,
  "ai_volume_delta": 123,
  "volume_updated_at": "2023-11-07T05:31:56Z",
  "is_active": true,
  "archived_at": "2023-11-07T05:31:56Z"
}

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

​
prompt_id
integer
required

Query Parameters

​
website_id
integer
required

Target website id

Body

application/json

Schema for updating a prompt

​
content
string | null
​
topic_id
integer | null
​
localizations
string[] | null
​
intent
enum<string> | null
Available options:
informational,
comparative,
transactional,
navigational
​
journey_stage
enum<string> | null
Available options:
discovery,
consideration,
decision,
retention
​
source_keyword
string | null

Response

Successful Response

Base prompt schema

​
id
integer
required
​
content
string
required
​
created_at
string<date-time>
required
​
topic_id
integer | null
​
topic_name
string | null
​
localizations
string[]
​
intent
enum<string> | null
Available options:
informational,
comparative,
transactional,
navigational
​
journey_stage
enum<string> | null
Available options:
discovery,
consideration,
decision,
retention
​
source_keyword
string | null
​
visibility_score
number
default:0
​
visibility_delta_7d
number | null
​
status
enum<string>
default:unclaimed

Derived health status for a prompt.

Computed at query time from the current visibility score and the 7-day delta. Not persisted: changing thresholds is a no-op migration.

Thresholds (validated with product):

  • WINNING: score >= 70 AND delta_7d >= 0
  • AT_RISK: 30 <= score < 70 OR delta_7d <= -10
  • LOSING: score < 30 AND delta_7d < 0
  • UNCLAIMED: score == 0 (no platform cites the website)
Available options:
winning,
at_risk,
losing,
unclaimed
​
top_platforms
PromptPlatformBreakdownSchema · object[]
​
sentiment_score
number | null
​
sentiment_highlights_count
integer
default:0
​
sentiment_positive_count
integer
default:0
​
sentiment_negative_count
integer
default:0
​
sentiment_neutral_count
integer
default:0
​
ai_search_volume
integer | null
​
ai_volume_delta
number | null
​
volume_updated_at
string<date-time> | null
​
is_active
boolean
default:true
​
archived_at
string<date-time> | null