Skip to main content
PATCH
Update custom contact field
Required scope: CRM_WRITE
This endpoint performs a partial update. Only the fields you send are modified. key and type cannot be changed.

Body fields

Renaming options

Option keys stay stable. To rename an option, send its current key with the new label. An option sent without a matching key is treated as new and gets a key derived from its label. Options missing from the list are removed.

Fields synced from a CRM

A field whose source is not allo is managed by your CRM integration and cannot be edited. Any update returns 409 ATTRIBUTE_MANAGED_BY_INTEGRATION. Built-in fields such as name or company return 400 ATTRIBUTE_BUILT_IN.

Response

Returns 200 with the updated field, in the same shape as List custom fields.

Errors

Authorizations

Authorization
string
header
required

Path Parameters

key
string
required

Field key, as returned by the list endpoint

Example:

"lead_status"

Body

application/json

All fields are optional

label
string

New display name. The key does not change.

description
string

Free-text description of the field. A blank value clears it.

options
object[]

Replaces the full option list. DROPDOWN fields only. Send an option's current key to keep it when renaming its label.

Response

The updated field

data
object

A custom field on people