Enrichment

Preflight Enrichment

Check an enrichment request before running it. Free: nothing is written, queued or charged.

Errors for input a run could never use: an unknown mode (400 invalid_mode), zero or negative contact IDs (400 invalid_record_ids), a list that is not in this organization (404 list_not_found), an unknown target_field (400 unsupported_field), an unknown provider (400 unsupported_provider / unsupported_provider_for_field) and a missing AI config (404 ai_config_not_found).

Otherwise returns what the run would do: the unique contact IDs (repeats are counted once), contacts that are not on the list, the providers that would run, and plain warnings such as "Lusha is not connected: add your key" or "No providers chosen: using your saved pipeline".

post/enrichment/preflight

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/enrichment/preflight
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

list_idinteger required

List ID the contacts belong to

contact_idsinteger[] required

Contact IDs to enrich (duplicates are counted once)

modestring

'auto' (AI when ai_group_id is set, else waterfall), 'waterfall' or 'ai-research'

ai_group_idstring nullable

group_id of a saved AI enrichment config (required for 'ai-research')

providersstring[] nullable

Ordered provider names for a waterfall run. Omit to use the list's saved pipeline; an empty list also uses the saved pipeline (a warning says so).

target_fieldstring nullable

Column to enrich: a canonical CONTACT_/COMPANY_ column or a synonym like 'phone' or 'email'

email_verificationboolean

Add ZeroBounce email verification

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.