Skip to content

Create Formula Config

POST
/enrichment/formula/configs/{column_id}

Attach a formula to a column. FREE.

A formula is evaluated locally from data already on the record, so neither saving nor running one calls a provider or spends a credit. It is the cheapest way to derive a column.

Authorizations

Parameters

Path Parameters

column_id
required

Column the formula fills.

string

Column the formula fills.

Query Parameters

list_id
Any of:
integer

Scope the formula to one list. Omit for a global one.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Attach a formula to a column.

object
config
required

A formula and the metadata that explains it.

object
ai_prompt
Any of:
string
complexity
Any of:
string
explanation
Any of:
string
field_dependencies
Any of:
Array<string>
formula
required
string
output_type
Any of:
string
data_type
string
default: text
field_to_enrich
required
string
name
required
string

Responses

201

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