View as Markdown

Save Companies

POST/v2/companies/save

Save companies into your workspace, optionally into company lists. Send company ids, or identify a company by linkedin_id, linkedin_url or domain (at most 50 such items per request). The answer buckets every item into saved, not_matched, invalid and failed, echoing its identifier. A company already saved keeps its first saved_at, so a retry is safe. A ledger failure answers 200 with the items under failed (failed_count > 0). Free: spends no credits; 1 unit of the enrich rate limit per item without an id, none for a save by id.

Body parameters

  • dataone of[]required

    Companies to save (1-500): a company id, or an object identifying it by id, linkedin_id, linkedin_url or domain. At most 50 items may come without an id.

  • list_idsstring[]optional

    Company lists to put every saved company in (0-20), each a company list of your workspace (another id answers 400). Default: none.

Responses

  • 200 Every item in exactly one bucket, with the bucket counts in metadata (credits is null: nothing is spent). Retry the items under failed.
  • 400 Invalid request (VALIDATION_ERROR): a malformed body or unknown key, more than 50 items without an id (out_of_range), one identifier with different lookup keys (conflicting_fields), or a list_ids entry that is not a company list of your workspace.
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 429 Over the enrich rate limit (RATE_LIMIT); wait Retry-After seconds. Sent only where rate limits are enforced.
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.