Skip to main content
POST
Check a formula before you save 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

type
string
required

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

field_key
string | null

The field the formula is for, when it exists: a formula that refers back to it is refused

Response

200 - application/json

Successful Response

valid
boolean
required
errors
FormulaIssue · object[]
referenced_fields
string[]
warnings
FormulaIssue · object[]