Skip to content
firmus.shdocs

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

Create a watchlist

A new list of followed companies, with its filters, its digest and, if you send them, its first numbers.

name is required, up to 200 characters. Every other field is optional and takes its default: severity_floor (critical, notable or informational; notable), include_kinds and exclude_kinds (arrays of event kinds; []), include_establishments and include_bulk (false), digest_frequency (off, daily or weekly; off) and digest_recipients (up to 10 addresses; [], and required when the digest is not off). Send numbers (SIRENs or SIRETs, up to 1 000) or the job_id of a finished file job to watch its first companies in the same request; not both.

The answer is 201 Created, with the list's URL in Location, the list, the organization's allowance and results: one status per number sent in numbers or matched by the job_id, in order — added, already_watched, not_found or invalid. A not_found number is not watched. A list created from its name alone answers results: []; GET and PATCH answer the list without results.

Refused with 400 invalid_request for a field this API does not know, an unknown kind, severity or frequency, a boolean other than true, false, 1 or 0, a digest with no recipient, more than 1 000 numbers (100 000 from a job), or an organization that already holds 100 lists. With numbers that would take the organization past its watched-companies allowance, nothing is created and the answer is 402 quota_exceeded, with no Retry-After. The contract below lists only some of the optional fields in its request body; the list above is the whole of what is accepted. Not counted as a call. Every field is explained in watch companies.

POST/v1/{country_code}/watchlistsScope read

Parameters

ParameterInTypeRequiredExample
country_codepathstringYesfr

Request

bash
curl -X POST -H "Authorization: Bearer $FIRMUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Key accounts","numbers":["552032534","55203253400041"]}' \
  "https://api.firmus.sh/v1/fr/watchlists"

Responses

Adds up to 1 000 numbers (SIRENs or SIRETs) to a list, from `numbers` or a finished CSV job's matched rows (`job_id`). All or nothing against the plan's watched entities: a request that would cross the allowance adds nothing and is a 402. A number neither the registry nor the event log knows is `not_found` and is not watched.

  • watchlistobject
    • idinteger
    • namestring
    • country_codestring
    • watchedinteger
    • severity_floorstring
    • include_kindsstring[]
      • []stringoptional
    • exclude_kindsstring[]
      • []stringoptional
    • include_establishmentsboolean
    • include_bulkboolean
    • digestobject
      • frequencystring
      • recipientsstring[]
        • []stringoptional
      • sent_atunspecifiednullable
    • created_atstring
    • updated_atstring
  • resultsobject[]
    • []objectoptional
      • numberstring
      • statusstring
  • allowanceobject
    • includedinteger
    • usedinteger