Allo

Create company attribute

Creates a custom attribute on your team's companies. The key is derived from the label. The call is idempotent: if an attribute with the same key and type…

POST/v2/api/crm/companies/attributes

Body fields

FieldTypeRequiredDescription
labelstringyesDisplay name, 1 to 255 characters, with at least one letter or digit
typestringyesTEXT, NUMBER, DATE, BOOLEAN or DROPDOWN
optionsarrayDROPDOWN onlyAt least one { label, key? } object. Rejected for other types
promptstringnoInstruction the AI CRM Manager follows to fill this attribute from calls
should_prompt_overridebooleannoWhether the AI may overwrite a value that is already set

Key derivation

The key is derived from the label: lowercase, accents removed, runs of non-alphanumeric characters replaced by _, truncated to 64 characters. Industry segment becomes industry_segment. Option keys are derived the same way.

A label that resolves to a reserved key is rejected with ATTRIBUTE_KEY_RESERVED. The reserved keys are: id, name, phone_numbers, website, industry, logo_url, last_activity, activity_history, sms_content, created_at and updated_at.

Response

Returns 201 with the created attribute. source is allo, and already_existed is false.

{
  "data": {
    "key": "industry_segment",
    "label": "Industry segment",
    "type": "DROPDOWN",
    "options": [
      { "key": "smb", "label": "SMB" },
      { "key": "enterprise", "label": "Enterprise" }
    ],
    "is_visible": true,
    "prompt": "Pick the segment that matches the company size mentioned on the call.",
    "should_prompt_override": false,
    "source": "allo",
    "created_at": "2026-10-07T14:21:08",
    "updated_at": "2026-10-07T14:21:08",
    "already_existed": false
  }
}

Creating the same attribute twice

The call is safe to repeat. If an attribute with the same key and type already exists, the endpoint returns 201 with that attribute and already_existed set to true. Nothing is created and the existing definition is left unchanged. If the key exists with a different type, the request returns 409 ATTRIBUTE_KEY_CONFLICT.

Limits

Each type has a fixed number of slots per team. Once a type is full, creating another attribute of that type returns 409 ATTRIBUTE_SLOTS_EXHAUSTED. Delete an unused attribute or use another type.

Custom attributes are only available to teams on the new contact model. Other teams get 404 TEAM_NOT_FOUND.

Errors

StatusCodeWhen
400ATTRIBUTE_LABEL_INVALIDlabel is blank, longer than 255 characters, or has no letter or digit
400ATTRIBUTE_KEY_RESERVEDThe label resolves to a reserved key
400ATTRIBUTE_OPTION_INVALIDA DROPDOWN attribute has no options, or an option label is blank, longer than 255 characters or duplicated
400ATTRIBUTE_OPTIONS_NOT_SUPPORTEDoptions sent for a type other than DROPDOWN
400INVALID_REQUEST_BODYtype is missing or unknown
403API_KEY_INSUFFICIENT_SCOPEThe key does not hold CRM_WRITE
404TEAM_NOT_FOUNDThe workspace is not on the new contact model
409ATTRIBUTE_KEY_CONFLICTAn attribute with this key already exists with another type
409ATTRIBUTE_SLOTS_EXHAUSTEDNo free slot is left for this type
409ATTRIBUTE_CONCURRENT_MODIFICATIONAttributes were modified at the same time. Retry the request

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Body

labelstringrequired

Display name of the attribute. The attribute key is derived from it: lowercase, accents removed, runs of non-alphanumeric characters replaced by _, truncated to 64 characters. Labels that resolve to a reserved key are rejected.

typeenum<string>required

TEXTNUMBERDATEBOOLEANDROPDOWN

optionsobject[]

Allowed values. Required, with at least one option, for DROPDOWN; rejected for other types.

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

Responses

201The attribute that was created, or the existing one when already_existed is true
dataobject

A custom attribute on companies

11 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>
already_existedboolean

true when an attribute with the same key and type already existed and nothing was created

400
401
403
404
409
429