Skip to main content
POST
Deactivate or reactivate prompts in bulk

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, Radar topics, prompt suggestions, and prompt analysis results
  • prompts:write: Create, update, archive prompts and generate, edit, or review prompt suggestions
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • analytics:write: Write events to analytics
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Body

application/json
productId
string
required
Minimum string length: 1
pollingPaused
boolean
required

true deactivates the prompts (stops scheduled runs, keeps history); false reactivates them.

promptIds
string[]

Prompt ids to change.

Maximum array length: 2000
Minimum string length: 1
messages
string[]

Exact prompt messages to change. Surrounding whitespace is trimmed, then the match is exact and case-sensitive.

Maximum array length: 2000
Required string length: 1 - 10000
answerEngines
enum<string>[]

Only change the prompts' conversation queries on these answer engines. Defaults to every engine.

Minimum array length: 1
Available options:
chatgpt,
sonar,
gemini,
claude,
claude-code,
deepseek,
google-ai-mode,
openai-codex,
grok-bot,
muse,
dots,
instinct

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required