Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.outx.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Modify an existing Reddit watchlist without losing its ID or collected posts. Every field is optional, send only the properties you want to change. The endpoint accepts two body shapes. Either patch fields (documented below) or send a new prompt to have OutX regenerate the entire keyword set in the background (Prompt mode at the bottom of this page).

​
Request Body (patch mode)

​
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.
​
keywords
array
Replace the tracked keywords on the watchlist. Accepts the same shape as the Create endpoint, simple strings or advanced keyword objects with required_keywords (AND) and excluded_keywords (NOT).Simple format:
["self-hosted crm", "indie hacker"]
Advanced format:
[
  {
    "keyword": "crm",
    "required_keywords": ["self-hosted"],
    "excluded_keywords": ["salesforce", "enterprise"]
  }
]
When this field is present, the watchlist’s existing keywords and associated reddit_tracking tasks are deleted and recreated from the new list. Omit the field to leave keywords untouched.
​
labels
array
Replace the custom labels on the watchlist. Same shape as Create.
[
  { "name": "buying intent", "description": "Threads asking for tool recommendations" },
  { "name": "competitor", "description": "Competitor mentions" }
]
If you pass keywords but not labels, the API falls back to keyword-derived labels (one label per keyword). Omit both to leave labels untouched.
​
disable
boolean
Set to true to pause tracking, false to resume.
​
slack_webhook_url
string | null
Update or clear the Slack webhook URL for this watchlist. Pass null to clear.

​
Semantics

  • Keyword replacement is wipe-and-recreate. Existing keyword_tracking rows and their reddit_tracking tasks are deleted, then new ones are created from the payload. Posts already collected are not deleted, they remain attached to the watchlist and visible via the Posts API.
  • Only reddit_tracking tasks are touched. Any other task types on the same watchlist are left alone.
  • Partial updates are safe. Sending only { "id": "...", "name": "new name" } changes just the name; keywords, labels, and tasks are untouched.
curl -X PUT \
  "https://api.outx.ai/api-reddit-watchlist" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Updated Reddit Watchlist",
    "fetchFreqInHours": 12
  }'

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

​
Response Fields

​
id
string
Watchlist ID that was updated.
​
name
string
Updated watchlist name (only present when name was in the request).
​
fetchFreqInHours
number
Updated fetch frequency (only present when fetchFreqInHours was in the request).
​
disable
boolean
Current active/disabled status (only present when disable was in the request).
​
keywords
array
Array of primary keywords after the update (only present when keywords was in the request).
​
results
array
Per-keyword creation result (only present when keywords was in the request). Each entry has success, keyword, and either keyword_id or error.
​
labels
array
Labels persisted on the watchlist (only present when labels or keywords was in the request).
​
updated
boolean
Whether the update was successful.
​
message
string
Success message.

​
Error Responses

Status CodeError MessageDescription
400Missing required parameter: idWatchlist ID is required
400No valid update fields providedBody did not include any updatable fields
400keywords array is required and must not be emptykeywords was passed but empty or not an array
400No valid keywords provided after cleaningAll keywords were empty strings after normalization
400Invalid fetchFreqInHours. Allowed values: 1, 3, 6, 12, 24, 48, 72 (hours)Unsupported fetch frequency
400disable must be a boolean valuedisable sent as a non-boolean
400Name cannot be emptyname was an empty or whitespace-only string
401Missing API Key / Invalid API KeyMissing or invalid x-api-key header
404Watchlist not found or access deniedWatchlist does not exist, is not a Reddit list, or is not yours
See Error Codes for the full list.

​
Prompt mode

Replace the prompt on an existing Reddit watchlist. OutX wipes the existing keywords and labels and regenerates them from the new prompt in the background. Use this when you want to redirect a watchlist to a different angle without recreating it.

​
Request Body

​
id
string
required
Watchlist ID to update.
​
prompt
string
required
New natural-language prompt. OutX regenerates keywords and labels from this, replacing the current set.
curl -X PUT \
  "https://api.outx.ai/api-reddit-watchlist" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "prompt": "Track Reddit threads about Postgres-based vector databases and indie projects building with pgvector"
  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "prompt": "Track Reddit threads about Postgres-based vector databases and indie projects building with pgvector",
  "updated": true,
  "message": "Prompt updated. Keywords and labels are being regenerated in the background."
}
Same wipe-and-recreate semantics as a keywords patch: existing keyword_tracking rows and pending reddit_tracking tasks are deleted, but historical posts remain attached to the watchlist.

​
Frequently Asked Questions

name, fetchFreqInHours, keywords, labels, disable, and slack_webhook_url, any combination. Every field except id is optional; unspecified fields are left unchanged.
When you pass a keywords array, the API deletes the watchlist’s existing keyword_tracking rows and their associated reddit_tracking tasks, then creates new ones from your payload. The watchlist ID stays the same, and previously collected posts remain accessible via the Posts API.
No. Changing the name, fetch frequency, keywords, or labels does not delete posts that have already been collected. If you update fetchFreqInHours, the new interval takes effect from the next scheduled fetch cycle.
Yes. Send only id and labels. The existing keywords and their tasks are untouched.