Bulk

Bulk enrich people

Enriches up to 25,000 people in one call. Each item is what /v2/enrich/persons (email, or name with a company) or /v2/fetch/persons (LinkedIn URL) takes, priced like it. The credits of every item are reserved at once, up to the balance (items past it read insufficient_credits and cost nothing), and given back for what is not found. Duplicates of an earlier item are enriched once and cost nothing. Answers 202 at once with the task: follow it at links.self (wait=N holds the request until it settles), or pass webhookUrl to receive one POST when it settles; once it is completed or cancelled, links.results gives the results CSV, one row per item in the order sent. families adds the contact finders (contact_email, contact_phone) and needs their permission; emailType chooses the kind of email. A field the body or an item does not define is refused with 422 UNKNOWN_FIELD (the field, the one it most likely stands for, the accepted fields), never ignored: the task would otherwise run without it. An API key with credit limits must hold the whole reservation: a task that would take it over its daily, monthly or total limit is refused with KEY_CREDIT_LIMIT_REACHED before anything is reserved, and a started task counts against the key what it reserved, then only what it spent once it settles. Following a task, cancelling it and downloading its results stay open at a zero balance. Credits: the unit price of each item, as /v2/enrich/persons, /v2/fetch/persons and /v2/contact/*. The request itself is free.

post/v2/bulk

Request

  • Base URL
    https://api.reversecontact.com
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Optional. A key you choose (1 to 255 printable ASCII characters, a UUID for example) that makes the request safe to retry. For 24 hours, a request with the same key and the same body returns the first response with Idempotent-Replayed: true, without starting another lookup or debiting credits.

Request body

familiesstring[]

What to look up for each item (default: profile)

emailType'professional' | 'personal' | 'any'

With contact_email: the kind of email to look for

liveboolean

Scrape LinkedIn URL items live instead of reading saved data (default false)

taskNamestring

A name for the task history (default: Sent via API)

webhookUrlstring uri

Public HTTPS URL that receives one POST when the task settles: { event: task.updated, taskId, type, status, pollUrl, resultsUrl, occurredAt }. It carries no results. A failed POST (timeout, network error, 408, 429, 5xx) is retried for about 3 hours, so the same event can arrive twice: key it on taskId and status.

Response

Bulk enrich task created

successtrue required
errorunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.