Skip to main content
PATCH
Update Prompt Status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

The unique identifier for the brand

prompt_id
integer
required

The unique identifier for the prompt to update

Body

application/json

Body of the prompt PATCH. status is the only mutable field - a prompt's text, platforms and labels are fixed at create time.

status
enum<string>
required

The lifecycle status to move the prompt to.

  • paused - stop collecting for this prompt and release its variants from the organization's prompt pool; its configuration and history are kept
  • active - resume collecting with the exact deployment the prompt had when it was paused

archived is not accepted here - archive a prompt with DELETE /{brand_id}/prompts/{prompt_id}.

Available options:
active,
paused

Response

The prompt after the transition. Also returned when the prompt was already in the requested status.

Represents a prompt being tracked for AI visibility, including its configuration and metadata.

id
integer
required

Unique identifier for the prompt

text
string
required

The prompt text being tracked

stage
string
required

The customer journey stage this prompt represents. Returned as the display name of the brand's active stage — one of the brand's default set (Advice, Awareness, Evaluation, Comparison, Other for intent brands; Awareness, Consideration, Conversion, Loyalty, Other for funnel brands) or a custom stage name.

persona_id
integer | null
required

ID of the associated persona, if any

platforms
enum<string>[]
required

AI platforms this prompt is tracked on

Available options:
chatgpt,
claude,
google_ai_overviews,
perplexity,
meta,
google_ai_mode,
google_gemini,
copilot,
grok
tags
string[]
required

Custom tags assigned to this prompt

topics
string[]
required

Auto-detected or assigned topics for this prompt

status
enum<string>
required

Lifecycle status of the prompt (active, paused, or archived)

Available options:
active,
paused,
archived
created_at
string<date-time>
required

Timestamp when the prompt was created