AddCompanies

View as Markdown
Add up to **100** companies to your workspace's blacklist in one call. Leads working at a blacklisted company are excluded from your campaigns. Each entry takes one or both of the following, and **at least one is required**: - **url** *(optional)*: a LinkedIn company URL, `linkedin.com/company/...`, with or without `https://` and `www.`. The URL is reduced to the company slug, so every spelling of the same company - scheme, host, query string, fragment, trailing slash, an `/about/` suffix - collapses onto one entry. School URLs and bare domains such as `acme.com` are rejected. - **name** *(optional)*: a name-only entry, excluding by exact, case-insensitive company-name comparison. Returned as `BroadMatch`. **The call returns 200 even when some entries do not land**, following the same partial-success model as 'AddLeads': - **added**: how many entries were newly created. - **entries**: one reference per input that produced a stored entry, correlated by **inputIndex** (its position in the list you submitted). **id** is what you pass to 'RemoveCompanies', and **created** is `false` when the company was already blacklisted. - **duplicates**: identifiers that were already blacklisted, or repeated within this batch. - **validationErrors**: one message per entry that was skipped, for example an invalid URL or an entry with no identifier at all.

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}

Request

This endpoint expects an object.
companieslist of objectsRequired

Response

OK
addedinteger
duplicateslist of strings
validationErrorslist of any
entrieslist of objects