Allo

Update company attribute

Partially updates an attribute: only the fields you send change. key and type cannot be changed. Attributes synced from a CRM integration only accept prompt…

PATCH/v2/api/crm/companies/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
optionsarrayReplaces the full option list with { label, key? } objects. DROPDOWN attributes only
promptstringInstruction for the AI CRM Manager. A blank value clears it
should_prompt_overridebooleanWhether the AI may overwrite a value that is already set
is_visiblebooleanShow or hide the attribute in the Allo apps

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.

Attributes synced from a CRM

An attribute whose source is not allo is managed by your CRM integration. Only prompt, should_prompt_override and is_visible can be changed. Sending label or options returns 409 ATTRIBUTE_MANAGED_BY_INTEGRATION.

Response

Returns 200 with the updated attribute, in the same shape as List company attributes.

Errors

StatusCodeWhen
400ATTRIBUTE_LABEL_INVALIDlabel is blank, longer than 255 characters, or has no letter or digit
400ATTRIBUTE_OPTION_INVALIDoptions is empty, or an option label is blank, longer than 255 characters or duplicated
400ATTRIBUTE_OPTIONS_NOT_SUPPORTEDoptions sent for an attribute that is not DROPDOWN
403API_KEY_INSUFFICIENT_SCOPEThe key does not hold CRM_WRITE
404TEAM_NOT_FOUNDThe workspace is not on the new contact model
404ATTRIBUTE_NOT_FOUNDNo attribute with this key
409ATTRIBUTE_MANAGED_BY_INTEGRATIONlabel or options sent for an attribute managed by a CRM integration
409ATTRIBUTE_CONCURRENT_MODIFICATIONAttributes were modified at the same time. Retry the request

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

keystringrequired

Attribute key, as returned by the list endpoint

Body

labelstring

New display name

optionsobject[]

Replaces the full option list. DROPDOWN attributes 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.

promptstring | null

Instruction the AI CRM Manager follows to fill this attribute from calls. A blank value clears it.

should_prompt_overrideboolean

Whether the AI may overwrite a value that is already set

is_visibleboolean

Show or hide the attribute in the Allo apps

Responses

200The updated attribute
dataobject

A custom attribute on companies

10 fields
keystring

Unique key within your team

labelstring | null

Display name

typeenum<string>

TEXTNUMBERDATEBOOLEANDROPDOWN

optionsobject[]

Allowed values. Only set for DROPDOWN attributes.

2 fields
keystring
labelstring
is_visibleboolean

Whether the attribute is shown in the Allo apps

promptstring | null

Instruction the AI CRM Manager follows to fill this attribute from calls. A blank value clears it.

should_prompt_overrideboolean | null

Whether the AI may overwrite a value that is already set

sourcestring

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

created_atstring<date-time>
updated_atstring<date-time>
400
401
403
404
409
429