Skip to main content
POST
Two formats supported, and both are additive:

LinkedIn URL

Every new account needs its LinkedIn company page URL: linkedin.com/company/acme, or the company’s numeric id, linkedin.com/company/1035. With or without https://www., a trailing slash or a query string. A person’s profile, a school page or a showcase page is refused. Clustr checks the URL’s shape only. To find it, search the company on LinkedIn and copy the address of its page.
  • Single object: a missing or invalid URL answers 422 with code invalid_linkedin_url and the reason, and nothing is added.
  • Batch: an entry without a valid URL is not added and is listed in rejected with its position in the request and the reason. The other entries are added. When no entry is left to add, the call answers 422.
Accounts already on your list are unchanged, with or without a URL.

Tier

Either format accepts a tier per account: the name your workspace uses for it, from List Account Tiers. An unknown tier name rejects the whole request rather than creating the tier or quietly dropping it. A typo in a 500-row import would otherwise become a permanent tier nobody chose, and a dropped one loses data you believed you sent. The error names both the tier you sent and the row it was on. A tier belongs to the company behind an account, and a brand-new account has usually not been matched to one yet. When that happens the tier is queued on the account and applied automatically as soon as the match happens, so nothing is lost in the gap. You do not have to poll or re-send it.

Tag

Either format accepts a tag per account: one of your account tags, as your workspace spells it, from List Tags. The tag is added to the account, also when the company is already on your list. An unknown tag name rejects the whole request. Tags are never created this way.

Authorizations

Authorization
string
header
required

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

Body

application/json

Accepts two formats:

  • Single object: {"company_name": "...", "linkedin_url": "...", "tier": "..."} adds one account.
  • Batch array: {"target_companies": [...]} adds every account in the list and skips the ones already present.

Every new account needs its LinkedIn company page URL, such as linkedin.com/company/acme or linkedin.com/company/1035. An entry without a valid one is listed in rejected instead of being added.

company_name
string

The company name, in the single object format.

Example:

"Acme Corp"

linkedin_url
string

The company's LinkedIn page URL, in the single object format. Required for a new account.

Example:

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

tier
string

The tier name, spelled the way your workspace spells it, in the single object format. An unknown tier name is rejected.

Example:

"Tier 1"

tag
string

An account tag name, spelled the way your workspace spells it, in the single object format. The tag is added to the account. An unknown tag name is rejected.

Example:

"Strategic"

target_companies
object[]

The batch format: a list of accounts to add to your existing ones. Accounts already present are skipped.

Response

Target accounts created

success
boolean
required
Example:

true

data
object
required