Enrichment

Run Formula Column

Compute a formula column for records. Free: formulas run locally.

WRITES to every record in scope. With no ids and no mode that is the list's records up to max_records; dry_run validates without writing.

post/enrichment/formula/configs/{column_id}/run

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/enrichment/formula/configs/{column_id}/run
  • Auth: HTTP bearer

Path parameters

column_idstring required

The enrichment column id.

Query parameters

list_idinteger nullable

Scope to a list's configuration.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

record_idsinteger[] nullable
visible_record_idsinteger[] nullable
context_record_idsinteger[] nullable
mode'selected' | 'visible' | 'empty' nullable
max_recordsinteger nullable
batch_sizeinteger
dry_runboolean

Validate only; write nothing.

Response

Successful Response

dataEnrichmentPayload 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.

Changes

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