Skip to main content
POST
Add companies to a monitor
New hire monitoring requires a V2 workspace API key. Legacy V1 API keys are not supported by these endpoints. Monitors and their credits belong to the V2 workspace associated with the key.
Add 1 to 10,000 companies per request to a company-list monitor with { "companies": [{ "linkedin_url": ... }] }. Companies the monitor already watches are ignored, and the 201 response reports the monitor, its complete company list, added_company_count, and baseline_reset.
Adding a company restarts the baseline. Adding a company the monitor does not already watch changes its scope: the monitor discards undelivered findings, cancels an in-progress check, and rebuilds its baseline on the next check, so hires that started before the change are not reported. The response has baseline_reset: true. Adding only companies the monitor already watches is a no-op (added_company_count: 0, baseline_reset: false).
A monitor holds at most 10,000 companies; exceeding it returns 422 company_limit_reached. Invalid or duplicate URLs in the request return 422 invalid_companies. A market monitor has no company list (422 market_monitor_has_no_companies), and monitors created before role filters existed can only be edited in the app (422 legacy_monitor). The JSON request body must fit within 8 MiB (8,388,608 bytes); larger bodies return 413. Adding companies spends no credits.

Next step

Use Get a new hire monitor to follow each company’s resolution.

Authorizations

Authorization
string
header
required

Use an Airscale workspace API key. Never expose the key in client-side code.

Path Parameters

monitor_id
string<uuid>
required

Body

application/json

Provide 1–10,000 LinkedIn company URLs in a JSON body of at most 8 MiB (8,388,608 bytes), without exceeding 10,000 companies in the monitor.

companies
object[]
required

1–10,000 LinkedIn company URLs. Two entries for the same company are rejected.

Required array length: 1 - 10000 elements

Response

The monitor after the addition, with its complete company list.

monitor
object
required
companies
object[]
required

The monitor's company list, sorted by URL. Empty for a market monitor.

added_company_count
integer
required
Required range: 0 <= x <= 10000
baseline_reset
boolean
required

true when at least one company was added and the baseline will be rebuilt.