Watchlists

Quote and confirm the matching of a watchlist's companies

See what it costs to start watching a large company list, and say yes — for a New Decision Maker or Account watchlist whose list you sent through the API or synced from HubSpot.

Before a company can be watched for new decision makers it is matched to its LinkedIn company page, and each match is billed. A small list is matched straight away; above a set amount nothing is matched or charged until you confirm, and the signal's warnings carry MATCHING_CONFIRMATION_REQUIRED with the quote. You are also told without asking: the account owners get an email with the quote and a link to confirm in the dashboard, and the signal's webhookUrl receives a signal.action_required event.

Input: signalId (path) and confirm: false (default) returns the quote only, true accepts it and starts the matching.

Output: status (awaiting_confirmation, confirmed, insufficient_credits or nothing_to_match), companiesToMatch, alreadyMatchedFree (companies matched before, free), billableCompanies, pricePerCompany, currency, estimatedCost (an upper bound — a company is charged only once it is matched), sufficientBalance and confirmationRequired.

Send the LinkedIn company URL of each company when you have it: it is matched exactly, and a numeric company URL (/company/1234567) is already matched and never billed.

post/api/v1/watchlists/{signalId}/companies/confirm-matching

Request

  • Base URL: https://api.rodz.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.rodz.io/api/v1/watchlists/{signalId}/companies/confirm-matching
  • Auth: HTTP bearer

Path parameters

signalIdstring required

Id of the watchlist signal, as returned by the create endpoint.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

confirmboolean

true confirms the cost quoted for matching this watchlist's companies and starts the matching. false (default) only returns the quote.

Example request

{
  "confirm": true
}

Response

Successful Response

status'nothing_to_match' | 'awaiting_confirmation' | 'insufficient_credits' | 'confirmed' required

confirmed: matching runs (or needs no confirmation). awaiting_confirmation: nothing is matched or charged until you call this endpoint with confirm: true. insufficient_credits: your balance does not cover estimatedCost; top up, then confirm. nothing_to_match: every company is already matched.

companiesToMatchinteger required

Companies not yet matched.

alreadyMatchedFreeinteger required

Of those, companies we have already matched before: free.

billableCompaniesinteger required
pricePerCompanynumber required
currency'credits' | 'eur' required

The unit of pricePerCompany and estimatedCost.

estimatedCostnumber required

At most this much is charged: a company is charged only once it is matched.

isUpperBoundboolean
sufficientBalanceboolean required
confirmationRequiredboolean required

True when the cost is above the amount we match without asking.

Example response

{
  "alreadyMatchedFree": 8880,
  "billableCompanies": 40612,
  "companiesToMatch": 49492,
  "confirmationRequired": true,
  "currency": "credits",
  "estimatedCost": 2030.6,
  "isUpperBound": true,
  "pricePerCompany": 0.05,
  "status": "confirmed",
  "sufficientBalance": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.