WIwithallo
CRM

Update custom company attribute

Changed on

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, should_prompt_override and is_visible.

patch/v2/api/crm/companies/attributes/{key}

Request

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

Path parameters

keystring required
Example:industry_segment

Attribute key, as returned by the list endpoint

Request body

labelstring

New display name

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

is_visibleboolean

Show or hide the attribute in the Allo apps

Example request

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

Response

The updated attribute

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