Enrich a list's people
Enriches the people on one of your people lists in a job: finds the work email, phone number or both that each row lacks, and saves what was found on the rows. find and providers work as on POST /v1/people/enrich.
A run takes up to maxRows rows (10,000 at most, and when it is left out) from offset (0 when left out) in the list’s order. Enrich a longer list in runs, each with offset where the last one ended: 0, then 10,000, then 20,000.
The answer is the job, with 202. Follow it with GET /v1/jobs/{jobId}, then read what was found with GET /v1/lists/{listId}/rows. A list with nothing to enrich answers a job that has already ended, at no cost. Another organization’s list answers 404 list_not_found, and a company list 422 people_list_required. Stop a running job with POST /v1/jobs/{jobId}/cancel.
To cap what the job may cost, send maxSpendUsd, in US dollars. A job that could cost more, going by what it would hold, answers 422 max_spend_exceeded with the amount it could cost, and nothing is held or started.
Price: per value found, by who found it: an email $0.02 from the package or $0.05 from the waterfall, a phone number $0.05 from the package or $0.10 from the waterfall. With providers package, every value costs the package price. Values a person already had are free. When the job starts, the most it can cost is held from your balance: for each row, $0.02 to find an email, $0.05 a phone number or $0.07 both with the package, or $0.05, $0.10 and $0.15 with the waterfall. When it ends it is charged for what it found, and the rest is released. Starts have their own limit, 10 a minute and 200 a day. Scope: enrichment, with a key that can write.
Authorizations
Headers
Names this operation, so a retry with the same key and body gets the first success again, marked Idempotent-Replayed, instead of running or charging twice. A mailbox's password is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (4xx) frees the key at once, so a corrected retry runs. After a server error (5xx), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers 409 idempotency_in_progress; after that, a send or import that may already have gone out answers 409 idempotency_outcome_unknown instead of running again. 1 to 255 visible ASCII characters, such as a UUID.
1 - 255^[\x21-\x7E]+$Path Parameters
Body
Response
The job, started. Read its progress and result with GET /v1/jobs/{jobId}. A list with nothing to enrich answers a job that already ended, at no cost.