View as Markdown

Create Company Enrichment

POST/v2/companies/enrichments

Starts a job that matches up to 10,000 companies (by LinkedIn URL, domain or name) against GetProspect. Free: no credits. The job runs at once and the answer carries no estimate: poll it at Location (GET /v2/jobs/{id}) or read it at GET /v2/enrichments/{id}, or subscribe once to job.finished with POST /v2/webhooks. A row with none of the three is accepted and counted under counts.invalid. At most 5 enrichments are active per workspace. With an Idempotency-Key, a retry answers the job it created. 1 jobs rate-limit unit.

How are credits spent?

Company enrichment jobs are free.

How the job works

Send up to 10,000 rows, the same items as Company Bulk Enrich without id and linkedin_id (domain, name or linkedin_url), each with an optional identifier of yours. The answer is 202 with the job and Location: /v2/jobs/{id}; the job is already running. A row with no usable lookup is kept and reported as invalid.

Poll the job or subscribe to job.finished, then page the results with Get Enrichment Results: one item per row in request order, matched rows with the same company object the sync bulk enrich returns. See Bulk jobs: poll or webhook.

Body parameters

  • namestringoptionalmax length: 128

    A label for the job.

  • dataobject[]required

    Array of company lookup rows (1-10000). Each row is matched independently.

    FieldTypeDescription
    identifierstringClient-supplied correlation key echoed back with the row result. If omitted, the row index is used. max length: 128.
    linkedin_urlstringThe LinkedIn company URL. max length: 512.
    domainstringThe company domain. max length: 512.
    namestringThe company name. max length: 512.

Responses

  • 202 The job, matching.
  • 400 Invalid body or Idempotency-Key, more than 10,000 rows, or no row with a usable identifier combination (VALIDATION_ERROR). A row without one is otherwise accepted and ends in counts.invalid.
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 409 CONFLICT: 5 enrichments are already active in the workspace (limit_reached, payload.limit), or the Idempotency-Key was used for another request (idempotency_key_reused), or its first request is still running (idempotency_in_progress, Retry-After: 2).
  • 429 Over the jobs rate limit (RATE_LIMIT); wait Retry-After seconds. Sent only where rate limits are enforced for the caller channel.
  • 500 Unexpected server error.

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