PUT Watchlist API - Update Watchlist

PUT Watchlist

Update Watchlist API allows you to modify an existing watchlist.

You can update several properties of the watchlist, such as:

Name – rename the watchlist to keep it organized or aligned with new use cases.
Fetch frequency – control how often data is refreshed for the watchlist.
Status – enable or disable the watchlist without permanently deleting it.

All PUT data should be sent in the JSON format (UTF-8 encoding).

This endpoint is designed to help you maintain flexibility and keep your watchlists up to date as your monitoring needs evolve.

Quick Set up Guide

To get your API KEY mail us support@outx.ai
Create a watchlist using the POST endpoint
Retrieve posts using the GET endpoint with your watchlist ID
Update watchlist settings as needed using the PUT endpoint
Like and Comment using Engagement APIs

Curl

curl -X PUT "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-watchlist"
  -H "x-api-key: YOUR_TEAM_API_KEY_HERE"
  -H "Content-Type: application/json"
  -d '{
    "id": "your-watchlist-id",
    "fetchFreqInHours": 6
  }'

Authentication

x-api-key: “YOUR TEAM API KEY HERE”

Parameters

Essential Parameters

Parameter	Type	Description
id	string	The unique ID of the watchlist to update.

Optional Parameters

Parameter	Type	Description
name	string	New name for the watchlist. Cannot be empty.
fetchFreqInHours	number	Fetch frequency in hours. Allowed values: 1, 3, 6, 12, 24, 48, 72.
disable	boolean	Disable or enable the watchlist. Values: true (disabled), false (enabled).

Request Body

Retrieve your UUID-string from POST Watchlist response

{
  "id": "uuid-string",
  "name": "Updated Name",
  "fetchFreqInHours": 12,
  "disable": false
}

Response

Success (200) – Watchlist Updated

{
  "id": "uuid-string",
  "name": "Updated Name",
  "fetchFreqInHours": 12,
  "disable": false,
  "updated": true,
  "message": "Watchlist updated successfully"
}

Field	Type	Description
id	string	Unique watchlist identifier (UUID).
name	string	Updated name of the watchlist.
fetchFreqInHours	number	Frequency (in hours) at which the watchlist fetches new data.
disable	boolean	Indicates whether the watchlist is disabled (true) or active (false).
updated	boolean	Whether the update action was successful.
message	string	Confirmation message about the update status.

Errors

Status Code	Error Message	Description
400	"id is required"	The id parameter is missing.
401	"Unauthorized: Invalid API key"	Authentication failed due to an invalid or missing API key.
500	"Database error message"	Internal server error occurred while processing the request. Contact support @OutXAI