Skip to main content
PUT
Author (or clear) a formula on an entity field

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required
entityId
string
required

Body

application/json
formula
string | null
required

Formula source in the formula DSL (e.g. self.qty > 4). Pass null to clear an existing formula on the field.

key
string
required

Field key to author the formula on — the same key used in the entity's values/formulas maps (not the field's display name).

branchId
string

Response

200 - application/json
formulaTemplates
object
required
formulas
object
required
id
string
required
values
object
required
branchesChangedIn
string[]
branchesCreatedIn
string[]
createdAt
string<date-time>
defaultSortKey
string
deleted
boolean
type
string
uniqueEntityNumber
number
updatedAt
string<date-time>