Skip to content
firmus.shdocs

Every page's text, headings and title. Code samples are not indexed.

Remove watches

Stop watching some numbers of a list, which frees their share of the allowance.

The numbers go in the query string, comma-separated, as strings of digits:

curl -s -X DELETE -H "Authorization: Bearer $FIRMUS_KEY" \
  "https://api.firmus.sh/v1/fr/watchlists/1/watches?numbers=552032534,55203253400041"

numbers is required, although the contract below marks it optional: a comma-separated string of up to 1 000 numbers, sent as you received them, leading zeros kept. Without it the answer is 400 invalid_request.

Each number answers removed, not_watched (not in this list) or invalid, in the order sent, with counts, the list's watched total and the allowance. A number that no other list of the organization watches frees its unit at once. Not counted as a call.

DELETE/v1/{country_code}/watchlists/{watchlist_id}/watchesScope read

Parameters

ParameterInTypeRequiredExample
country_codepathstringYesfr
watchlist_idpathintegerYes1
numbersquerystringNo552032534,542065479

Request

bash
curl -X DELETE -H "Authorization: Bearer $FIRMUS_KEY" \
  "https://api.firmus.sh/v1/fr/watchlists/1/watches"

Fields

  • resultsobject[]
    • []objectoptional
      • numberstring
      • statusstring
  • countsobject
    • removedinteger
    • not_watchedinteger
  • watchedinteger
  • allowanceobject
    • includedinteger
    • usedinteger

Responses

Removes the numbers of `numbers`, comma-separated, from a list.