ProductSearchCTIX

Network live

CTIXPOST

Add Keyword to Watchlist

POSThttps://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/

Adds a keyword to the watchlist.

Body Parameters

Name	Type	Required	Description
is_email_alert	boolean	optional	Pass true to send an email alert about the watchlist occurrences; otherwise, pass false.
external_recipients	object	optional	Pass a list of email addresses of the external recipients.
internal_recipients	object	optional	Pass a list of unique IDs and details of the internal recipients.
name	string	optional	Pass the value of the keyword.

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.

CTIXConnect to Intel ExchangeRequired to change data

Credentials required for POST

Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.

Base URL

Access ID *Secret Key *

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.

Request body (JSON)Valid JSON

cURL

curl --request POST \
  --url "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
  --data '{
  "is_email_alert": false,
  "external_recipients": {},
  "internal_recipients": {},
  "name": "sample keyword"
}'

View-only example — running live API calls requires a role with snippet testing access.

JavaScript

const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";

const response = await fetch(url, {
  method: "POST",
  headers: {},
  body: JSON.stringify({
    "is_email_alert": false,
    "external_recipients": {},
    "internal_recipients": {},
    "name": "sample keyword"
  }),
});

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.

Python

import requests

url = "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/"
params = {
    "AccessID": "<your access id>",
    "Signature": "<your signature>",
    "Expires": "<your expires>"
}
headers = {}
payload = {
  "is_email_alert": false,
  "external_recipients": {},
  "internal_recipients": {},
  "name": "sample keyword"
}
response = requests.request("POST", 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.

Request Body

{
  "is_email_alert": false,
  "external_recipients": {},
  "internal_recipients": {},
  "name": "sample keyword"
}

View-only example — running live API calls requires a role with snippet testing access.

Example Response

{
  "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.