Skip to main content
POST
Restore a prompt

Authorizations

Authorization
string
header
required

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

Path Parameters

prompt_id
integer
required

Query Parameters

website_id
integer
required

Target website id

Body

application/json
replace_with
integer | null

Response

Successful Response

id
integer
required
content
string
required
created_at
string<date-time>
required
topic_id
integer | null
topic_name
string | null
tags
TagOnPromptSchema · object[]
localizations
string[]
intent
enum<string> | null
Available options:
informational,
comparative,
transactional,
navigational
journey_stage
enum<string> | null
Available options:
discovery,
consideration,
decision,
retention
brand_scope
enum<string> | null
Available options:
branded,
non_branded
brand_scope_manual
boolean
default:false
source_keyword
string | null
visibility
number
default:0
visibility_delta_7d
number | null
answer_count
integer
default:0
visibility_reference
number | null
reference_answer_count
integer
default:0
visibility_delta_reference
number | null
status
enum<string>
default:unclaimed
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
archive_reason
enum<string> | null
Available options:
quota,
user