Enrich a person
Finds a person’s work email, phone number or both, and saves the person, with what was found, as a contact in your workspace. Name the person one way: by personId (the id of their row from GET /v1/lists/{listId}/rows, or the id an earlier enrich or upload answered), by linkedinUrl, or by a name (firstName, lastName or both, or fullName) with companyName or companyDomain.
find says what to look for: email (the default), phone or email_and_phone. providers says where: package (the default) searches our own data package; waterfall searches the package, then a fixed series of further providers until one finds it. A waterfall search can take over a minute, so allow two minutes for the answer.
The answer lists the person’s work email addresses whose check showed valid or catch-all, and every phone number they now have with what checking it showed (hq is the company’s main line). Personal email addresses are left out and never charged. found holds what this call found that the person did not have, with who found it (foundBy): those values are what the call is charged for.
A personId your organization does not have answers 404 person_not_found. While another call is enriching the same person, a call answers 409 enrichment_in_progress and costs nothing: try again once it finishes. A person with too little to search with answers 422 person_not_identifiable.
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 the person already had are free, and a call that finds nothing costs nothing. Before the search runs, the most it can cost for what find asks is held from your balance, and what it does not use is released. 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 person's email addresses and phone numbers after the call, and what it found.