Skip to content

Update Waterfall Configuration

PUT
/enrichment/waterfall/configs/{column_id}

Replace a waterfall’s steps and settings. DEFINES SPEND.

Graded like its create sibling POST /enrichment/waterfall/configs: the definition picks which PAID providers run, is_system_provider charges graph8 credits per call, email_verification adds a paid verification per address, and auto_update keeps the column refreshing on its own. config.org_id is ignored; the key’s organisation is used.

Authorizations

Parameters

Path Parameters

column_id
required

The enrichment column id.

string

The enrichment column id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Replace a waterfall’s definition.

object
config
required

A complete waterfall definition.

org_id and created_by are accepted for shape parity with the app and IGNORED: the organisation always comes from the API key.

object
auto_update
boolean
default: true
column_id
required
string
created_by
Any of:
string
data_type
string
default: text
email_verification
Any of:

Verify found emails after the waterfall. PAID per address when use_system_credentials is true.

object
accept_catchall
boolean
enabled
boolean
default: true
provider
string
default: zerobounce
Allowed values: zerobounce hunter icypeas leadmagic emaillistverify
use_system_credentials

Use graph8’s provider keys (charges credits) rather than your own.

boolean
default: true
valid_statuses
Array<string>
field_to_enrich
required
string
hide_provider_columns
boolean
default: true
id
Any of:
string format: uuid
is_existing_column
boolean
is_global
boolean
default: true
list_id
Any of:
integer
list_routing
Any of:

Route records into lists by their verification result.

object
copy_columns
boolean
enabled
boolean
field_name
string
default: email_verified
list_mappings

Verification status -> list id.

object
key
additional properties
integer
routing_columns
Any of:
object
key
additional properties
any
name
required
string
only_run_if
Any of:
string
org_id
Any of:
string
output_successful_provider
boolean
skip_existing_values
boolean
default: true
skip_recently_enriched
boolean
default: true
steps
required
Array<object>

One provider attempt in a waterfall.

object
action
required
string
action_display_name
required
string
confidence_threshold
number
<= 1
config
object
key
additional properties
any
enabled
boolean
default: true
id
required
string
input_mapping
object
key
additional properties
string
is_system_provider

Use graph8’s provider credentials. Those calls are charged.

boolean
max_retries
integer
<= 3
order
required
integer
output_field
Any of:
string
output_mapping
Any of:
object
key
additional properties
string
provider
required

Provider name, from GET /enrichment/providers.

string
stop_on_success
boolean
default: true
target_column_name
Any of:
string
validate_emails

Deprecated: use email_verification.

boolean

Responses

200

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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