Skip to main content
POST
Register a competitor to monitor. Enforces the per-workspace slot limit and returns 409 when no active slot is available. Requires the competitor-monitoring entitlement (403 when the feature is off).
Registering starts the competitor’s first scan. That is the point of this endpoint being the only way in: a scan fires when a competitor is added or when the weekly schedule fires, and at no other time. There is no on-demand trigger.The scan starts in the background, so the response comes back immediately with the created competitor. Watch it with GET /competitor-runs. If the scan fails to start the competitor still exists and the weekly run picks it up.

Body

string
required
Competitor company name.
string
Company domain. Recommended for accurate account matching.
string
LinkedIn company page URL.