Update an entity watch
Updates an entity watch in place. status, entities, config, and notifications are
mutable, so the watched list is yours to edit without recreating the watch. track and
fields are fixed at creation and sending either returns 400.
People or companies added by a PATCH are baselined silently on the next run: they establish
their own starting snapshot first, so adding a subject never fires a spurious notification.
A cancelled watch cannot be modified or reactivated.
Authorizations
API key passed as a Bearer token in the Authorization header.
Headers
API version to use. 2025-11-01 is the only accepted value. Send it on every call: it is
enforced today on POST /watch/{dataset}/search, where a missing or unrecognized value returns
400, and the other watch routes accept a request without it rather than relying on that.
2025-11-01 "2025-11-01"
Path Parameters
The dataset the watch is built on. Entity watches support person and company; there is no
job entity watch, and job returns 404 here. Use /watch/job/search for jobs.
person, company "person"
The watch's id, returned when it was created.
46936
Body
Body for updating an entity watch. Only these four keys are accepted. Sending track, fields,
dataset, kind, api_version, filters, sorts, or on returns 400.
active, paused, cancelled "paused"
The records to watch, as a map of identifier type to values. The accepted keys are exactly the ones the dataset's enrich endpoint accepts, and they are resolved to canonical ids when the watch runs. One watch holds up to 50,000 subjects across all keys.
People accept professional_network_profile_urls and business_emails. Companies accept
domains, names, professional_network_profile_urls, and crustdata_company_ids. Company
ids must be positive integers; every other identifier is a non-empty string.
Schedule, per-run caps, and data freshness for an entity watch.
One delivery channel. Every channel on a watch receives every notification.
- Option 1
- Option 2
- Option 3
- Option 4
Response
The updated watch.
An entity watch, as returned by create, get, list, and update.
46936
entity "entity"
person, company "person"
"2025-11-01"
"2025-11-01"
active, paused, suspended, expired, cancelled "active"
The records to watch, as a map of identifier type to values. The accepted keys are exactly the ones the dataset's enrich endpoint accepts, and they are resolved to canonical ids when the watch runs. One watch holds up to 50,000 subjects across all keys.
People accept professional_network_profile_urls and business_emails. Companies accept
domains, names, professional_network_profile_urls, and crustdata_company_ids. Company
ids must be positive integers; every other identifier is a non-empty string.
The saved track tree.
- Option 1
- Option 2
Schedule, per-run caps, and data freshness for an entity watch.
One delivery channel. Every channel on a watch receives every notification.
- Option 1
- Option 2
- Option 3
- Option 4
"2026-07-16T03:16:38.351849Z"
"2026-07-16T13:39:18.598964Z"
12
60
"2026-07-16T13:39:18.598964Z"
Related topics
Delete an entity watchCompany Entity WatcherPerson Entity WatcherList entity watchesGet an entity watch