Skip to main content
POST
Compute a formula on a few records without saving it

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Body

application/json
formula
EquationFormula · object
required

A formula: EQUATION (an expression over this record's fields, e.g. {arr} * 1.1), ROLLUP (aggregate a field of related records), CROSS_OBJECT (copy a field of one related record) or TIME_CALCULATION (time since, until or between dates). GET /v1/formulas/functions lists the expression functions.

object
string
required

The object the formula is on; one of: account, contact, opportunity

record_ids
string[]
required

The records to compute the formula on

Required array length: 1 - 50 elements
type
string
required

The field's type (number, text, date, boolean, ...): the formula must produce it

Response

200 - application/json

Successful Response

valid
boolean
required
errors
FormulaIssue · object[]

Set when the formula is not valid

results
PreviewRow · object[]