Consumes CreditsThis endpoint consumes Apollo credits per enriched record when data is returned. Learn more about API pricing and credits.
Enrichment is when you refresh existing records so your prospecting data is up-to-date.
Use the Bulk People Enrichment endpoint to enrich data for up to ten people with a single API call. To enrich data for a single person, use the People Enrichment endpoint instead.
Apollo relies on the information you pass via the endpoint's parameters to identify the correct people to enrich. When you provide more information, Apollo is more likely to find matches within its database. If you only provide general information, such as a name without a domain or email address, you may receive a 200 response, but the response indicates that no records have been enriched. The details for each person should be passed as an object in the details[] array.
By default, this endpoint doesn't return personal emails or phone numbers. Use the reveal_personal_emails parameter to retrieve personal emails and reveal_phone_number to retrieve phone numbers. If you set either of these parameters to true, Apollo attempts to provide emails or phone numbers for all matches.
When you use reveal_phone_number, a valid webhook_url is required so Apollo can deliver the completed phone enrichment results. Apollo returns the main enrichment response synchronously, then sends the requested phone numbers to the webhook asynchronously. See webhook details.
You can also use the run_waterfall_email and run_waterfall_phone parameters to run waterfall enrichment via this endpoint. Waterfall enrichment gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers.
When you call this endpoint and include at least one waterfall parameter, a valid webhook_url is required so Apollo can deliver the completed waterfall enrichment results. Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo then delivers enriched emails or phone numbers asynchronously to the configured webhook.
Webhook Details
-
When using native phone enrichment, the webhook response follows: Native webhook response details.
-
When using waterfall enrichment, the webhook response follows: Waterfall webhook response details.
-
You can poll webhook results with the Poll Webhook Result endpoint by passing the
request_idfrom the bulk people enrichment response.
Webhook Requirements
-
HTTPS Required: Your endpoint must be publicly accessible over HTTPS.
-
Rate Limiting: Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo.
-
Idempotency: Apollo may retry webhook calls. Your endpoint should be idempotent to handle duplicate payloads safely.