Update Watchlist

Rename or re-describe a watchlist.

Updates a watchlist's title and/or description. The list type is immutable — if you send it, it is ignored. Pass description: null to clear the description.

Update watchlist

PUT/api/v2/watchlists/{kind}/{watchlist_id}

Path parameters

ParameterTypeDescription
kindstringWatchlist kind: company or profile (matches the list type).
watchlist_idintegerIdentifier of the watchlist.

Request body

FieldTypeDescription
titlestringOptional. New title, non-empty.
descriptionstringOptional. New description; pass null to clear it.

Example request

curl -X PUT "https://api.getsillage.com/api/v2/watchlists/company/128" \
  -H "Authorization: Bearer $SILLAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Key competitors (EMEA)", "description": "Refocused on EMEA" }'

Example response

{
  "data": {
    "id": 128,
    "kind": "company",
    "type": "competitor",
    "title": "Key competitors (EMEA)",
    "description": "Refocused on EMEA",
    "entity_count": 12,
    "bound_agent_count": 1
  }
}

Errors

StatusDescription
401The API key is missing or invalid.
404The watchlist does not exist in your workspace.
422Invalid watchlist_id or request body.
429Too many requests.

On this page