Información general

Se pueden añadir campos personalizados a los leads, contactos, empresas y listas.
La URL del método depende de la entidad.

Tipos de campos disponibles

Tipo	Nombre
text	Texto
numeric	Número
checkbox	Casilla de verificación
select	Lista
multiselect	Lista multiselección
date	Fecha
url	URL
textarea	Área de texto
radiobutton	Interruptor
streetaddress	Dirección corta
smart_address	Dirección
birthday	Cumpleaños
legal_entity	ID fiscal
date_time	Fecha y hora
price	Precio
category	Categoría
file	Archivo

Disponibilidad de tipos de campos para entidades

Field type	Contacto	Lead	Compañía	Lista
Texto	✅	✅	✅	✅
Número	✅	✅	✅	✅
Casilla de verificación	✅	✅	✅	✅
Lista	✅	✅	✅	✅
Lista multiselección	✅	✅	✅	✅
Multitexto	✅	❌	❌	❌
Fecha	✅	✅	✅	✅
URL	✅	✅	✅	✅
Fecha y hora	✅	✅	✅	✅
Área de texto	✅	✅	✅	✅
Interruptor	✅	✅	✅	✅
Dirección corta	✅	✅	✅	✅
Dirección	✅	✅	✅	❌
Cumpleaños	✅	✅	✅	❌
ID fiscal	✅	✅	✅	❌
Precio	❌	❌	❌	✅
Categoría	❌	❌	❌	✅
Productos	❌	❌	❌	✅
Archivo	✅	✅	✅	✅

Ejemplos de cómo completar diferentes tipos de campos a través de la API

A continuación, consideraremos ejemplos de solicitudes para completar valores de distintos tipos de campos.

Independientemente del tipo de campo, todos los valores se pasan en el arreglo de objetos custom_fields_values. Para completar un campo, necesitas enviar su ID o código de carácter, así como los valores mismos.

Parámetro	Tipo de dato	Descripción
custom_fields_values	array	Un arreglo que contiene información sobre los valores de campos adicionales definidos para la entidad
custom_fields_values[0]	object	Un objeto que contiene información sobre el valor del campo opcional definido para la entidad
custom_fields_values[field_id]	int	ID del campo cuyo valor estás completando
custom_fields_values[field_code]	string	El código de carácter del campo cuyo valor estás completando (debes enviar ya sea field_id o field_code para completarlo)
custom_fields_values[values]	array	Arreglo de valores a completar
custom_fields_values[values][0]	object	Objeto con el valor del campo. La estructura del objeto depende del tipo de campo

Tipos de campos:

text, numeric, textarea, price, streetaddress, tracking_data, monetary

En este ejemplo, considera una consulta para completar campos de tipo text, numeric, textarea, price, streetaddress, tracking_data y monetary.

Parámetro	Tipo de dato	Descripción
value	string	Valor del campo

...
"custom_fields_values": [
    {
        "field_id": 3,
        "values": [
            {
                "value": "Valor del campo"
            }
        ]
    },
    {
        "field_id": 103,
        "values": [
            {
                "value": "1.5"
            }
        ]
    },
    {
        "field_id": 203,
        "values": [
            {
                "value": "string1\nstring2"
            }
        ]
    },
    {
        "field_id": 303,
        "values": [
            {
                "value": "100"
            }
        ]
    },
    {
        "field_id": 403,
        "values": [
            {
                "value": "FRAY PEDRO DE GANTE NO. 108, TEXCOCO DE MORA CENTRO, 56100 "
            }
        ]
    }
],
...

checkbox

En este ejemplo, consideremos una solicitud para completar campos del tipo checkbox.

Parámetro	Tipo de dato	Descripción
value	bool	Valor del campo

...
"custom_fields_values": [
    {
        "field_id": 5,
        "values": [
            {
                "value": true
            }
        ]
    }
],
...

url

En este ejemplo, consideremos una solicitud para completar campos del tipo url.

Parámetro	Tipo de dato	Descripción
value	string	Valor del campo. URL delegada

...
"custom_fields_values": [
    {
        "field_id": 7,
        "values": [
            {
                "value": "https://www.kommo.com/"
            }
        ]
    }
],
...

date, date_time, birthday

En este ejemplo, considera una consulta para completar campos de tipo date, date_timey birthday

Parámetro	Tipo de dato	Descripción
value	int\|string	Valor del campo - Timestamp Unix o timestamp en formato RFC-3339

...
"custom_fields_values": [
    {
        "field_id": 9,
        "values": [
            {
                "value": 1577836800
            }
        ]
    },
    {
        "field_id": 109,
        "values": [
            {
                "value": 1591965296
            }
        ]
    },
    {
        "field_id": 209,
        "values": [
            {
                "value": 1586476800
            }
        ]
    }
],
...

select, multiselect, radiobutton, category

En este ejemplo, considera una consulta para completar campos como select, multiselect, radiobutton y category. Un valor puede pasarse como valor, ya sea mediante el código de caracteres del valor o el ID del valor.

Parámetro	Tipo de dato	Descripción
value	string	Valor del campo
enum_id	int	ID del Valor del campo (enum)
enum code	string	Código simbólico del valor del campo (enum)

...
"custom_fields_values": [
    {
        "field_id": 11,
        "values": [
            {
                "value": "valor 1"
            }
        ]
    },
    {
        "field_id": 111,
        "values": [
            {
                "enum_id": 17
            },
            {
                "enum_id": 19
            }
        ]
    },
    {
        "field_id": 211,
        "values": [
            {
                "value": "valor 4"
            }
        ]
    }
],
...

smart_address

En este ejemplo, considera una consulta para completar campos de tipo smart_address. El campo acepta múltiples valores. Los campos value y enum_ido enum_codedeben pasarse dentro del valor.

Parámetro	Tipo de dato	Descripción
value	string	Valor del campo
enum_id	int	Valor del campo. Valores disponibles: 1 - Primera línea de la dirección, 2 - Segunda línea de la dirección, 3 - Ciudad, 4 - Región, 5 - Código postal, 6 - País
enum_code	string	Código del valor del campo. Valores disponibles: address_line_1 - Primera línea de la dirección, address_line_2 - Segunda línea de la dirección, city - Ciudad, state - Región, zip - Código postal, country - País

...
"custom_fields_values": [
    {
        "field_id": 13,
        "values": [
            {
                "value": "FRAY PEDRO DE GANTE NO. 108",
                "enum_id": 1
            },
            {
                "value": "Ciudad de México",
                "enum_code": "ciudad"
            },
            {
                "value": "Estado de México",
                "enum_code": "estado"
            },
            {
                "value": "94080",
                "enum_id": 5
            },
            {
                "value": "México",
                "enum_code": "país"
            }
        ]
    }
],
...

multitext

En este ejemplo, consideremos una solicitud para completar campos de tipo multitext(Phone, Email). El campo acepta múltiples valores. Los campos value y enum_ido enum_codedeben pasarse dentro del valor.

Parámetro	Tipo de dato	Descripción
value	string	Valor del campo
enum_id	int	ID del valor del campo
enum_code	string	Código del valor del campo. Valores disponibles para el campo Phone: WORK - trabajo, WORKDD - trabajo directo, MOB - móvil, FAX - fax, HOME - casa, OTHER - otro. Valores disponibles para el campo Email: WORK - trabajo, PRIV - personal, OTHER - otro.

...
"custom_fields_values": [
    {
        "field_id": 31,
        "values": [
            {
                "value": "+52 229.986-6686",
                "enum_id": 48224
            },
            {
                "value": "+52 871.750-1786",
                "enum_code": "INICIO"
            }
        ]
    }
],
...

legal_entity

En este ejemplo, consideremos una consulta para completar campos de tipo legal_entity. Es obligatorio pasar el campo name dentro del valor.

Parámetro	Tipo de dato	Descripción
value	string	Field value
value[name]	string	Nombre de la organización
value[entity_type]	int	Tipo de entidad legal. 1 - Privada, 2 - Jurídica
value[address]	string	Dirección de la organización
value[real_address]	string	Dirección real de la organización
value[bank_account_number]	int	Número de cuenta bancaria
value[director]	string	Nombre SEO
value[vat_id]	int	Número de identificación fiscal de la organización (o su equivalente en tu país)
value[tax_registration_reason_code]	string	Tax registration reason code
value[bank_code]	string	Código bancario
value[external_uid]	string	ID del sistema externo

...
"custom_fields_values": [
    {
        "field_id": 25,
        "values": [
            {
                "value": {
                    "name": "Estrellas brillantes",
                    "entity_type": 1,
                    "vat_id": "123123123",
                    "tax_registration_reason_code": 213,
                    "address": "Ciudad de México",                  
                    "external_uid": "uuid"
                }
            }
        ]
    }
],
...

linked_entity

En este ejemplo, consideremos una consulta para completar campos de tipo legal_entity.

Parámetro	Tipo de dato	Descripción
value	object	Valor del campo
value[name]	string	Valor del campo mostrado. Se transmite para su visualización instantánea
value[entity_id]	int	Linked entity ID
value[entity_type]	string	Linked entity type (contacts, companies, etc.)
value[catalog_id]	int\|null	ID de la lista, si se especifica un enlace

...
"custom_fields_values": [
  {
    "field_id": 1150977,
    "values": [
      {
        "value": {
          "name": "Juan Hernández",
          "entity_id": 24833339,
          "entity_type": "contactos",
          "catalog_id": null
        }
      }
    ]
  },
  {
    "field_id": 1150979,
    "values": [
      {
        "value": {
          "name": "Producto 1",
          "entity_id": 527597,
          "entity_type": "catálogo_elementos",
          "catalog_id": 6319
        }
      }
    ]
  }
],
...

chained_list

En este ejemplo, considera una solicitud para completar un campo de tipo chained_list. El campo admite múltiples valores, hasta un máximo de 5 elementos.

Parámetro	Tipo de dato	Descripción
catalog_id	int	ID de la lista, si se especifica un enlace a la lista
catalog_element_id	int	ID del elemento de la lista, si se especifica un enlace a la lista

...
"custom_fields_values": [
  {
    "field_id": 1150985,
    "values": [
      {
        "catalog_id": 1001,
        "catalog_element_id": 12235
      },
      {
        "catalog_id": 1007,
        "catalog_element_id": 12243
      }
    ]
  }
],
...

file

En este ejemplo, considera una consulta para completar un campo de tipo file.

Parámetro	Tipo de dato	Descripción
value	object	Valor del campo
value[file_uuid]	string	UUID de um arquivo no serviço de arquivos
value[version_uuid]	string	UUID de la versión del archivo en el servicio de archivos
value[file_name]	string	Nombre del archivo
value[file_size]	int	Tamaño del archivo

...
"custom_fields_values": [
  {
    "field_id": 1150985,
    "values": [
      {
        "value": {
          "file_uuid": "3b454645-5c7f-4539-9ef9-0dd1b3638dad",
          "version_uuid": "13db6652-b3ed-4fff-aed8-0c6f3c43b887",
          "file_name": "wiki.odt",
          "file_size": 20763,
        }
      }
    ]
  }
],
...