Skip to main content
Modify your keyword watchlist settings including name, fetch frequency, and active status.

​
Request Body

​
id
string
required
Watchlist ID to update
​
name
string
New watchlist name
​
fetchFreqInHours
number
New fetch frequency. Allowed values: 1, 3, 6, 12, 24, 48, 72
​
disable
boolean
Set to true to disable the watchlist, false to enable it
curl -X PUT \
  "https://api.outx.ai/api-keyword-watchlist" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Updated Watchlist Name",
    "fetchFreqInHours": 24,
    "disable": false
  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Updated Watchlist Name",
  "fetchFreqInHours": 24,
  "disable": false,
  "updated": true,
  "message": "Watchlist updated successfully"
}

​
Response Fields

​
id
string
Watchlist ID that was updated
​
name
string
Updated watchlist name
​
fetchFreqInHours
number
Updated fetch frequency
​
disable
boolean
Current active/disabled status
​
updated
boolean
Whether the update was successful
​
message
string
Success message

​
Error Responses

Status CodeError MessageDescription
400Missing required parameter: idWatchlist ID is required
400Invalid fetchFreqInHours valueFetch frequency must be one of: 1, 3, 6, 12, 24, 48, 72
401UnauthorizedInvalid or missing API key
403Access deniedTrying to update watchlist from another team
404Watchlist not foundWatchlist ID doesn’t exist