---
title: "Update Waterfall Configuration"
method: PUT
path: "/enrichment/waterfall/configs/{column_id}"
tags: ["Enrichment"]
---

# Update Waterfall Configuration

`PUT /enrichment/waterfall/configs/{column_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/enrichment/waterfall/configs/{column_id}`
- Auth: HTTP bearer

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.

## Path parameters

- `column_id` string, required: The enrichment column id.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- UpdateWaterfallConfigRequest: Replace a waterfall's definition.
  - `config` WaterfallConfig, 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.
    - `id` string, uuid, nullable
    - `name` string, required
    - `column_id` string, required
    - `field_to_enrich` string, required
    - `data_type` string
    - `steps` WaterfallStep[], required
      - `id` string, required
      - `provider` string, required: Provider name, from `GET /enrichment/providers`.
      - `action` string, required
      - `action_display_name` string, required
      - `output_field` string, nullable
      - `output_mapping` object, nullable: Deprecated.
      - `input_mapping` object
      - `order` integer, required
      - `config` object
      - `enabled` boolean
      - `is_system_provider` boolean: Use graph8's provider credentials. Those calls are charged.
      - `stop_on_success` boolean
      - `confidence_threshold` number
      - `max_retries` integer
    - `is_existing_column` boolean
    - `target_column_name` string, nullable
    - `output_successful_provider` boolean
    - `hide_provider_columns` boolean
    - `skip_existing_values` boolean
    - `skip_recently_enriched` boolean
    - `validate_emails` boolean: Deprecated: use `email_verification`.
    - `email_verification` EmailVerificationConfig: Verify found emails after the waterfall. PAID per address when `use_system_credentials` is true.
      - `enabled` boolean
      - `provider` 'zerobounce' | 'hunter' | 'icypeas' | 'leadmagic' | 'emaillistverify'
      - `use_system_credentials` boolean: Use graph8's provider keys (charges credits) rather than your own.
      - `accept_catchall` boolean
      - `valid_statuses` string[]
    - `list_routing` WaterfallListRouting: Route records into lists by their verification result.
      - `enabled` boolean
      - `field_name` string
      - `list_mappings` object: Verification status -> list id.
      - `copy_columns` boolean
      - `routing_columns` object, nullable
    - `auto_update` boolean
    - `only_run_if` string, nullable: Run condition formula.
    - `list_id` integer, nullable
    - `is_global` boolean
    - `created_by` string, nullable: Ignored.
    - `org_id` string, nullable: Ignored: the key's organisation is used.

## Response `200`

Successful Response

- ApiResponseEnrichmentPayload
  - `data` EnrichmentPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)