Update a watchlist

Change a list's name, filters or email digest; the fields left out keep their value.

Takes the same fields as a creation, and changes only those sent; numbers and job_id are ignored here, so add numbers with add watches. A field left out keeps its value, so none is required, whatever the contract's request body below marks as required. include_kinds, exclude_kinds and digest_recipients are replaced whole, not merged. Answers 200 with the list as it now is.

Turning the digest on starts it from that moment: the first digest holds what the list matches from then on, not what it matched before. Changing the filters applies to the events matched from then on; events already delivered stay delivered.

Refused with 400 invalid_request on the same grounds as a creation, and 404 not_found for a list that is not your organization's. Not counted as a call.

PATCH/v1/{country_code}/watchlists/{id}Scope read

Parameters

Parameter	In	Type	Required	Example
country_code	path	string	Yes	fr
id	path	integer	Yes	1

Request

bash

curl -X PATCH -H "Authorization: Bearer $FIRMUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"include_establishments":true,"digest_frequency":"weekly","digest_recipients":["finance@example.com"]}' \
  "https://api.firmus.sh/v1/fr/watchlists/1"

Fields

watchlistobject
- idinteger
- namestring
- country_codestring
- watchedinteger
- severity_floorstring
- include_kindsunspecified[]
  - []unspecifiedoptional
- exclude_kindsunspecified[]
  - []unspecifiedoptional
- include_establishmentsboolean
- include_bulkboolean
- digestobject
  - frequencystring
  - recipientsstring[]
    - []stringoptional
  - sent_atunspecifiednullable
- created_atstring
- updated_atstring
allowanceobject
- includedinteger
- usedinteger

Responses

Changes a list's name, filters or digest; the fields left out keep their value.