Enrich people in a batch
Enriches 1 to 100 people in one job: finds each one’s work email, phone number or both, and saves each person, with what was found, as a contact in your workspace. Name each person one way, as POST /v1/people/enrich takes a person. find and providers work as they do there, for every person in the batch.
The answer is the job, with 202. Follow it with GET /v1/jobs/{jobId}: once it ends, results lists every person in the order you sent them, as POST /v1/people/enrich answers a person, or with an error: person_not_found, person_not_identifiable, enrichment_in_progress, enrichment_failed, or enrichment_not_run when the job ended before it reached them. A person named twice is enriched, and charged, once. Stop a running job with POST /v1/jobs/{jobId}/cancel.
For more than 100 people, add them to a list with POST /v1/lists/{listId}/rows, then enrich the list with POST /v1/lists/{listId}/enrich.
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 person, $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]+$Body
Response
The job, started. Read its progress and result with GET /v1/jobs/{jobId}.