CRM

Update custom contact field

Changed on

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 edited.

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

Request

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

Path parameters

keystring required
Example:lead_status

Field key, as returned by the list endpoint

Request body

labelstring

New display name. The key does not change.

descriptionstring

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

Example request

{
  "options": [
    {
      "label": "Enterprise",
      "key": "enterprise"
    }
  ]
}

Response

The updated field

Example response

{
  "data": {
    "key": "budget",
    "label": "Budget",
    "type": "NUMBER",
    "options": [
      {
        "key": "enterprise",
        "label": "Enterprise"
      }
    ],
    "source": "allo"
  }
}

Changes