Skip to content

Create Formula Template

POST
/enrichment/formula-templates

Save a reusable formula-authoring template. FREE.

A template is a stored prompt plus the fields it depends on; creating one calls no model. It costs when someone later authors a formula from it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Save a reusable formula-authoring template.

object
category
required
string
description
required
string
example_formula
Any of:
string
field_dependencies
required
Array<string>
is_system_template
boolean
name
required
string
output_type
required

‘text’, ‘number’ or ‘boolean’.

string
prompt
required
string
target_type
required

‘companies’ or ‘contacts’.

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