Skip to main content
Modify your people watchlist settings including name and active status.

​
Request Body

​
id
string
required
Watchlist ID to update
​
name
string
New watchlist name
​
disable
boolean
Set to true to disable the watchlist, false to enable it
curl -X PUT \
  "https://api.outx.ai/api-people-watchlist" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "id": "770e8400-e29b-41d4-a716-446655440000",
    "name": "Updated Tech Leaders",
    "disable": false
  }'

{
  "id": "770e8400-e29b-41d4-a716-446655440000",
  "name": "Updated Tech Leaders",
  "disable": false,
  "updated": true,
  "message": "Watchlist updated successfully"
}

​
Response Fields

​
id
string
Watchlist ID that was updated
​
name
string
Updated watchlist name
​
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
401UnauthorizedInvalid or missing API key
403Access deniedTrying to update watchlist from another team
404Watchlist not foundWatchlist ID doesn’t exist

​
Frequently Asked Questions

Q: What properties can I update on a people watchlist? You can update the watchlist name and the disable status (to pause or resume tracking). To modify the profiles being tracked, you would need to create a new watchlist with the updated list of profiles.
Q: Does updating a watchlist reset existing collected data? No. Updating a watchlist’s name or disable status does not affect any posts or data that have already been collected. Your existing data remains intact. Disabling a watchlist pauses future tracking, but all previously collected posts are still accessible via the Posts API.