Skip to main content
POST
Excludes one company. To exclude many at once, use Import excluded companies, which takes up to 500 in one request. Give at least one key, and as many as you know: different parts of Clustr match on different ones. The exclusion is checked before a company record exists, which is how it stops the enrichment rather than only hiding its result. Excluding a company that is already excluded returns the existing exclusion rather than a second one. Everything it hides is kept: remove the exclusion and it all comes back.

​
Errors

Authorizations

​
Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Body

application/json

One company to exclude. Send at least one of domain, linkedinVanityName, linkedinNumericId or companyId.

​
label
string

The name shown on the list, for display only. Defaults to the first key you give.

Example:

"Acme Corp"

​
domain
string

A domain or website, stored as the bare host: https://www.acme.com/about becomes acme.com. A LinkedIn URL sent here is read as linkedinVanityName.

Example:

"acme.com"

​
linkedinVanityName
string

The company's LinkedIn slug, or its LinkedIn company page URL (linkedin.com/company/acme-corp). A LinkedIn URL that is not a company page, such as a person's profile, is rejected.

Example:

"https://www.linkedin.com/company/acme-corp"

​
linkedinNumericId
string

LinkedIn's own numeric id for the company.

Example:

"1035"

​
companyId
string

The account's Clustr ID (acc_…), when you have one. The company id from earlier responses also works.

​
reason
string

Why the company is excluded. It is shown on the list, for display only.

Example:

"Competitor"

Response

The exclusion in force

​
success
boolean
Example:

true

​
data
object