Skip to main content
PATCH
Update Watch
Credits: 1 per mark per day (free during beta). Management requests cost 0 credits; the daily monitoring meter is separate.

Overview

Partial update: omitted fields are unchanged. Requires the portfolios:manage scope.

Path Parameters

string
required
Watch ID (wat_*).

Body Parameters

All fields optional.
string
1-255 chars.
object
Replace the entire saved query DSL. Same validation rules as Create Watch. A changed query is stored the way a create stores it: as a v3 watch on the similarity channels and the min_tier gate, whatever version it sends. So changing only q on a watch created before 2026-09-29 moves it to the new matching. A query with the deprecated strategies / min_match_tier keys is kept as a legacy watch until re-saved without them, and the response lists them in deprecations. Sending the stored query back unchanged changes nothing; the same holds for a v3 query that omits the defaults it is stored with. A query that differs from the stored one only where a write normalises it (offices added from jurisdictions, code or ID casing, duplicate IDs) is saved in that form and not migrated: a legacy watch stays legacy. The saved form can still change what the watch matches. For example, a watch stored with only jurisdictions is evaluated once the save adds its offices. So a GET then PATCH round trip never migrates a watch. See Watches created before 2026-09-29.
string
Only always_per_alert is accepted (same as Create Watch).
string
active or paused. Use Pause / Resume instead when you just want to toggle evaluation, they’re equivalent but read more clearly in your own code. A third status, disabled, exists but isn’t settable here: it’s the state a watch moves to when you delete it, and it’s excluded from List Watches by default.
object
Free-form metadata.

Response

Returns the updated Watch. When the new query used a deprecated key, the response also carries deprecations (see Create Watch).

Code Examples