Board Watches

Update a board watch

Changed on Nov 7, 2026

Partially update a watch you own. Omitted fields are left unchanged. Use isActive: false to pause and isActive: true to resume. A paused watch is skipped by every future notification but keeps its history and config. webhookUrl (webhook/both channel) and emailAddress (email/both channel) can be rotated, but not cleared. webhookSecret can be rotated, or cleared by sending an empty string "", which stops signing deliveries; null is refused. None of them can be set on a watch whose channel does not use them. isActive must be a boolean: null is refused with a 422 rather than read as false. To change channel itself, delete and recreate the watch.

Free.

patch/api/v1/watches/{watch_id}

Request

Base URL
https://api.vaquill.ai
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/vaquill/apis/vaquill-developer-api/docs/api/v1/watches/:watch_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

watch_idstring required

Id of the watch, as returned by POST /watches (id).

Request body

isActiveboolean nullable

Pause (false) or resume (true) the watch. null is refused with a 422.

webhookUrlstring nullable

New webhook URL. Only valid on a webhook/both channel watch. Re-validated against the SSRF blocklist. Cannot be cleared.

webhookSecretstring nullable

New signing secret, or an empty string to stop signing deliveries (the one clearable field; null is refused with a 422). Only valid on a webhook/both channel watch.

scopeobject nullable

Optional narrowing so this alert covers one citation instead of an entire source. Four mutually exclusive forms. Omit entirely to watch the whole source.

Hierarchy prefix: keys title, chapter, part, section, e.g. {"title": "21", "part": "314"} for 21 CFR part 314. Every level you set must match. title is required whenever any narrower level is set, and section also needs chapter or part. Sources without a title/chapter/part hierarchy return 400 (see scopable on GET /boards).

Exact section: {"actId": "CFR_T21_P314_S314_50"}, using the actId from search results and change events. Case-sensitive and validated at create time: an act_id we do not hold, or one from a different source, is a 400. Works on every source, and is the only way to follow a single Federal Register document.

Named source: {"source": "fdic_fil"}, for corpora that fold several independent bodies of law behind one corpusType. The agency_guidance board alone carries 47 named sources across 24 agencies, so an unscoped watch on it delivers FDIC letters, IRS notices, OFAC FAQs and DOE appliance standards together. Accepted on agency_adjudication, agency_guidance, agency_manuals, cfr, federal_rules; anything else returns 400. Pickable values are on the board's sources array in GET /boards.

Publishing agency: {"agency": "irs"}, covering every source that agency issues on the board (the IRS alone publishes 5 named series). Expanded when an event is matched, not when the watch is created, so a source registered later is covered automatically. Accepted on agency_adjudication, agency_guidance, agency_manuals; pickable values are on the board's agencies array in GET /boards.

emailAddressstring nullable

New email address. Only valid on an email/both channel watch. Cannot be cleared.

Example request

{
  "scope": {
    "part": "314",
    "title": "21"
  },
  "webhookAuth": {
    "headerName": "X-Api-Key"
  }
}

Response

The updated watch.

Example response

{
  "data": {
    "cadence": "weekly"
  }
}

Changes

Nov 7, 2026340c0d24d0b6 Revision changes
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history