Skip to main content
Change the natural-language prompt on an existing keyword watchlist. OutX replaces all existing keywords and intent labels with freshly generated ones based on the new prompt. Regeneration runs in the background.

Request Body

id
string
required
The watchlist ID to update.
prompt
string
required
The new natural-language prompt. OutX will regenerate keywords and labels from this prompt, replacing the current set.
curl -X PUT \
  "https://api.outx.ai/api-keyword-watchlist-prompt" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "prompt": "Track AI CRM tools, Salesforce alternatives, and enterprise sales automation"
  }'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "prompt": "Track AI CRM tools, Salesforce alternatives, and enterprise sales automation",
  "updated": true,
  "message": "Prompt updated. Keywords and labels are being regenerated in the background."
}

Response Fields

id
string
The watchlist ID that was updated.
prompt
string
The new prompt that was saved.
updated
boolean
true when the update was successful.
message
string
Status message indicating background processing.

Error Responses

Status CodeError MessageDescription
400Missing required parameter: idNo id provided
400prompt is required and must be a non-empty stringMissing or empty prompt
401Missing API Key / Invalid API KeyAPI key issue
404Watchlist not found or access deniedWatchlist doesn’t exist or belongs to another team