Updates the details of a keyword in the watchlist.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| watchlist_id | string | optional | Pass the ID of the watchlist keyword to update. |
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | Pass the value of the keyword. |
| is_active | boolean | optional | Pass true to activate the keyword, else pass false to deactivate. |
| is_removed | boolean | optional | Pass true to remove the keyword; otherwise, pass false. |
| is_email_alert | boolean | optional | Pass true to send an email alert about the watchlist occurrences, else pass false. |
| internal_recipients | object | optional | Pass a list of unique IDs and details of the internal recipients. |
| external_recipients | object | optional | Pass a list of email addresses of the external recipients. |
Run it
Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).
Playground
Request parameters
Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.
Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.
Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.
Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.
curl --request PUT \
--url "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/cd5acb44-506d-41ea-a347-54363c379b14/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"name": "sample keyword",
"is_active": true,
"is_removed": false,
"is_email_alert": false,
"internal_recipients": {},
"external_recipients": {}
}'View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/cd5acb44-506d-41ea-a347-54363c379b14/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "PUT",
headers: {},
body: JSON.stringify({
"name": "sample keyword",
"is_active": true,
"is_removed": false,
"is_email_alert": false,
"internal_recipients": {},
"external_recipients": {}
}),
});
const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);View-only example — running live API calls requires a role with snippet testing access.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/cd5acb44-506d-41ea-a347-54363c379b14/"
params = {
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"name": "sample keyword",
"is_active": true,
"is_removed": false,
"is_email_alert": false,
"internal_recipients": {},
"external_recipients": {}
}
response = requests.request("PUT", url, params=params, headers=headers, json=payload)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"name": "sample keyword",
"is_active": true,
"is_removed": false,
"is_email_alert": false,
"internal_recipients": {},
"external_recipients": {}
}View-only example — running live API calls requires a role with snippet testing access.
{
"id": "cd5acb44-506d-41ea-a347-54363c379b14",
"name": "sample keyword",
"created": 1703679482,
"modified": 1703679482,
"created_by": "a2b82e81-8e7d-4e68-8a36-3d2d9cd518ad",
"updated_by": "a2b82e81-8e7d-4e68-8a36-3d2d9cd518ad",
"last_activity_on": {},
"is_active": true,
"is_removed": false,
"is_email_alert": false,
"internal_recipients": {},
"external_recipients": {},
"occurrences": 0
}View-only example — running live API calls requires a role with snippet testing access.