Register Competitor
Register one or several competitors to monitor
companies. Requires the competitor-monitoring entitlement (403 when the feature is off).
You can register any number of competitors. Slots count people: when a new competitor’s first team search runs, the Sales and CS people it finds are monitored up to your free slots, highest ranked first, and the rest are added Paused (no slot). Preview Competitors tells you beforehand how many people each company has and how many slots that takes.
A company that is already one of your competitors is refused with 409 COMPETITOR_EXISTS, and the message ends with the existing competitor’s id. In the companies form its result has status: "exists" and existing_competitor_id. If the team search finds nobody, the competitor is still created with an empty team; add people by URL.
Pick the company first with Search LinkedIn Companies and pass its linkedin_numeric_id and linkedin_vanity_name. A linkedin_url sent without them is looked up here, and one that names no LinkedIn company page is refused with 422 COMPANY_NOT_RESOLVED: monitoring a page that does not resolve finds nobody.
companies, every created competitor gets its own first scan.companies.
Authorizations
Body
Either the single form (company_name and the fields beside it) or companies, a list of 1 to 20 companies in the same shape. company_name is required in the single form unless linkedin_url resolves to a company page.
The people the preview listed, each followed or skipped. Followed people are monitored up to the free slots, in this order, the rest paused; skipped people are never added by a later search. Omitted: the first search follows everyone it finds up to the free slots.
500Response
Competitors' answer, relayed; each new competitor's first scan then starts in the background. Single form: data.competitor and data.slot_usage. Bulk form: data.competitors (the ones created), data.results (one per company, in order) and data.slot_usage.