Consumes Credits
This 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 with the details[] array.
By default, this endpoint doesn't return personal emails or phone numbers. Use the reveal_personal_emails and reveal_phone_number parameters to retrieve emails and phone numbers. If you set either of these parameters to true, Apollo attempts to provide emails or phone numbers for all matches.
You can use 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, Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo delivers enriched emails and/or phone numbers asynchronously to a configured webhook.
Webhook Response Details:
-
When using native enrichment for phone number enrichment, the webhook response follows: Native webhook response details
-
When passing Waterfall flags, the webhook response follows: Waterfall webhook response details
-
You can poll webhook results with the Poll Webhook Result endpoint by passing
request_id.
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.