Skip to main content
PATCH
Update a field definition's display name, visibility, or requiredness

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.

Path Parameters

field_key
string
required

Query Parameters

object
string
required

The object the field belongs to: one of account, contact, opportunity, project, task, user, or a custom object's key (GET /v1/objects lists them)

Body

application/json
display_name
string | null
Required string length: 1 - 255
formula
EquationFormula · object

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.

hidden
boolean | null
mandatory
boolean | null

Response

200 - application/json

Successful Response

key
string
required
kind
enum<string>
required
Available options:
standard,
custom
label
string
required
type
string
required
currency_code
string | null
formula
Formula · object | null

Set on a formula field: how its value is computed, in the shape formula takes on POST /v1/fields

hidden
boolean
default:false
mandatory
boolean
default:false
object
string | null

The object whose id(s) the value holds: set on reference fields (one id) and on id lists such as a contact's accounts (type text_list)

option_labels
Option Labels · object | null
options
string[] | null
owner
enum<string>
default:statisfy
Available options:
statisfy,
crm,
warehouse,
integration,
ai,
computed
syncs_to_crm
boolean
default:false
writable
boolean
default:false