Skip to content

Run Waterfall Pipeline

POST
/enrichment/waterfall/enrich

Run a saved waterfall pipeline on specific records.

The handler loads the pipeline’s step list from the DB by column_id, which means providers that require credentials (Prospeo, Dropcontact, etc.) use whichever resolution the pipeline was saved with — the org’s own API keys OR graph8-managed system keys. Credits are deducted only for steps that actually run.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Run a saved waterfall pipeline on specific records.

object
column_id
required

Column_id from a saved waterfall pipeline

string
list_id
required

List ID the records belong to

integer
record_ids
required

Contact IDs to enrich

Array<integer>
skip_existing_values
Any of:
boolean

Responses

202

Successful Response

object
data
required
object
completed
Any of:
integer
failed_enrichments
Any of:
integer
job_id
required
string
provider_errors
Any of:
Array<object>
object
key
additional properties
any
results
Any of:
Array<object>
object
key
additional properties
any
status
required
string
successful_enrichments
Any of:
integer
total
Any of:
integer
total_credits_used
Any of:
integer
warnings
Any of:
Array<string>
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string