v2

latestOpenAPI 3.1.0Proprietary2026-07-26211984.6 KB
Watch

Update, pause, resume, or re-point a watch

All fields optional. Set paused true to pause or false to resume. webhookUrl and notifyEmail accept null to switch a channel off.

renderParams is MERGED, not replaced. A partial renderParams is deep-merged over the watch's existing render config, so you can change one knob (e.g. { "renderParams": { "darkMode": true } }) without re-sending the whole object. To clear a knob, set it to its default explicitly.

Re-baselining. Changing url clears the baseline so the next run re-baselines. A renderParams edit that changes WHAT is captured (a scope change — e.g. selector, fullPage, width/height, or device) likewise invalidates the baseline and re-baselines on the next run; a noise-only edit (e.g. threshold, ignoreRegions) does not.

patch/v1/watches/{id}

Path parameters

idstring uuid required

Watch UUID

Request body

urlstring uri
namestring
intervalMinutesinteger
diffMode'visual' | 'text' | 'both'
thresholdnumber
aiSummaryboolean
webhookUrlstring uri
notifyEmailstring email
pausedboolean

Response

The updated watch

successboolean