WIwithallo
CRM

Create custom contact field

Changed on

Creates a custom field on your team's people. The key is derived from the label. DROPDOWN fields need a non-empty options list. Creating the same label with the same type again returns the existing field with already_existed set to true. Creating a label that matches a deleted field restores it, with its previously stored values.

post/v2/api/crm/attributes

Request

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

Request body

labelstring required

Display name of the field. The key is derived from it: lowercase, accents removed, runs of non-alphanumeric characters replaced by _, truncated to 64 characters. Must contain at least one letter or digit and must not resolve to a built-in field key such as name, company or website.

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

Value type of the field

Example request

{
  "label": "Lead Source",
  "type": "TEXT",
  "options": [
    {
      "label": "Enterprise",
      "key": "enterprise"
    }
  ]
}

Response

The custom field that was created, restored or already existing

Example response

{
  "data": {
    "key": "lead_source",
    "label": "Lead Source",
    "type": "TEXT",
    "options": [
      {
        "key": "enterprise",
        "label": "Enterprise"
      }
    ]
  }
}

Changes