WIwithallo
CRM

Create custom company attribute

Changed on

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 already exists, it returns 201 with that attribute and already_existed set to true. options is required for DROPDOWN attributes and rejected for other types.

post/v2/api/crm/companies/attributes

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/crm/companies/attributes
  • Auth
    API key in header Authorization

Request body

labelstring required

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.

type'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'DROPDOWN' required
promptstring nullable

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

Example request

{
  "label": "Industry segment",
  "type": "DROPDOWN",
  "options": [
    {
      "label": "Enterprise",
      "key": "enterprise"
    }
  ],
  "prompt": "Pick the segment that matches the company size mentioned on the call."
}

Response

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

Example response

{
  "data": {
    "key": "industry_segment",
    "label": "Industry segment",
    "type": "DROPDOWN",
    "options": [
      {
        "key": "enterprise",
        "label": "Enterprise"
      }
    ],
    "prompt": "Pick the segment that matches the company size mentioned on the call.",
    "source": "allo"
  }
}

Changes