Allo

Update custom field

Partially updates a custom field on people: only the fields you send change. key and type cannot be changed. Fields synced from a CRM integration cannot be…

PATCH/v2/api/crm/attributes/{key}

This endpoint performs a partial update. Only the fields you send are modified. key and type cannot be changed.

Body fields

FieldTypeDescription
labelstringNew display name
descriptionstringDescription of the field. A blank value clears it
optionsarrayReplaces the full option list with { label, key? } objects. DROPDOWN fields only

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.

{
  "data": {
    "key": "lead_status",
    "label": "Lead temperature",
    "type": "DROPDOWN",
    "options": [
      { "key": "hot", "label": "Hot" },
      { "key": "warm", "label": "Warm" },
      { "key": "cold", "label": "Cold" }
    ],
    "source": "allo"
  }
}

Errors

StatusCodeWhen
400ATTRIBUTE_LABEL_INVALIDlabel is blank, longer than 255 characters, or has no letter or digit
400ATTRIBUTE_OPTION_INVALIDAn option label is blank, longer than 255 characters or duplicated
400ATTRIBUTE_OPTIONS_NOT_SUPPORTEDoptions sent for a field that is not DROPDOWN
400ATTRIBUTE_BUILT_INThe key is a built-in field, not a custom field
403API_KEY_INSUFFICIENT_SCOPEThe key does not hold CRM_WRITE
404TEAM_NOT_FOUNDThe workspace is not on the new contact model
404ATTRIBUTE_NOT_FOUNDNo field with this key, or the field was deleted
409ATTRIBUTE_MANAGED_BY_INTEGRATIONThe field is managed by a CRM integration

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

keystringrequired

Field key, as returned by the list endpoint

Body

labelstring

New display name. The key does not change.

descriptionstring

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

optionsobject[]

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

2 fields
labelstringrequired

Display name of the option

keystring

Existing option key. Send it when editing an attribute to keep the option's key stable while its label changes. Keys that do not match an existing option are ignored and a key is derived from the label.

Responses

200The updated field
dataobject

A custom field on people

5 fields
keystring

Unique key of the field within your team

labelstring | null

Display name of the field

typeenum<string>

Value type

TEXTNUMBERDATEBOOLEANDROPDOWN

optionsobject[]

Allowed values. Only set for DROPDOWN fields.

2 fields
keystring
labelstring
sourcestring

allo for fields created in Allo or with the API, otherwise the lowercase name of the integration that manages it, such as hubspot

400
401
403
404
409
429