Skip to main content
PATCH
Update one tracked prompt
Update a prompt’s isEnabled, isBranded, or isPinned state. Prompt text cannot be edited: sending a prompt that differs from the stored text returns 400. Delete the prompt and add a new one instead. Setting isEnabled: false untracks a prompt without deleting it. Its response history and topic cluster links are kept, and tracking the same prompt again re-enables it. Any update with isEnabled: true, alone or combined with other fields, is credit-checked: a prompt the balance cannot cover is not queued and is counted in skipped. The response then includes enabled, enqueued, and skipped. To change many prompts at once, use Bulk prompt actions. See Track Prompts.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Path Parameters

id
string
required

Body

application/json
teamId
string
isEnabled
boolean
isBranded
boolean
isPinned
boolean
prompt
string

Must match the stored text; prompts cannot be renamed.

enqueue
boolean

When false, enable the prompt without immediately running it.

Response

Default Response

success
boolean
updated
number
enabled
number
enqueued
number
skipped
number