Skip to main content
POST
Update a single custom field

Authorizations

x-api-key
string
header
required

Your organization's API key (starts with sk_live_)

Path Parameters

objectType
string
required

The object type slug. Use contacts for People, companies for Companies, or the slug of a Custom Object (e.g., deals, tickets).

Singular forms (contact, company) are also accepted.

Body

application/json
fieldName
string
required

Name of the custom field to update

Example:

"custom_score"

fieldValue
any
required

New value for the field

Example:

95

id
integer

Record ID (required for companies and custom objects)

Example:

123

email
string

Contact email (alternative to id for contacts)

Example:

"alex@acme.com"

Response

Field updated

data
object

A flat object containing all fields. System fields (name, email, phone, etc.) and custom fields are merged into a single level — the custom_fields JSON column is flattened so every field is a top-level key.

message
string
Example:

"Updated custom field 'custom_score' for contact"