patch https://{subdominio}.kommo.com/api/v4/catalogs//custom_fields
Este método permite actualizar múltiples campos personalizados de una lista.
Limitaciones
El método está disponible solo para usuarios administradores.
Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json.
Encabezado de tipo de datos en caso de un error
Content-Type: application/problem+json.
Parámetros de respuesta
Parámetro | Tipo de dato | Descripción | ¿Es el campo obligatorio? | Tipos de campos admitidos |
---|---|---|---|---|
id | int | ID del campo. | ❌ | Disponible para todos los tipos de campo. |
name | string | Nombre del campo. | ❌ | Disponible para todos los tipos de campo. |
code | string | Código del campo que se puede utilizar para actualizar el valor del campo sin pasar el ID del campo en la solicitud. | ❌ | Disponible para todos los campos de listas (catálogos). |
sort | int | Ordenación de los campos en el grupo de campos. | ❌ | Disponible para todos los campos de listas (catálogos). |
settings | object | Configuración de campos. | ❌ | Disponible para todos los campos de listas (catálogos). |
is_visible | bool | Define si el campo se muestra en la interfaz de la lista. | ❌ | Disponible para todos los campos de listas (catálogos). |
is_required | bool | Define si el campo es obligatorio al crear un elemento de la lista. | ❌ | Disponible para todos los campos de listas (catálogos). |
remind | string|null | Configuración de recordatorios de cumpleaños (nunca, día – día antes del evento, semana – semana antes del evento, mes – mes antes del evento). | ❌ | Disponible solo para los campos de tipo cumpleaños. |
enums | array | Arreglo de valores disponibles para el campo. | ✅(sólo si actualizas un campo de los tipos: multiselección botón de radio selección) | Disponible para los siguientes tipos de campo:: -multiselección -botón de radio -seleccionar |
enums[0] | object | Modelo de valor disponible para el campo. | ✅(sólo si actualizas un campo de los tipos: multiselección botón de radio selección) | Disponible para los siguientes tipos de campo:: -multiselección -botón de radio -seleccionar |
enums[0][value] | string | Valor. | ✅(sólo si actualizas un campo de los tipos: multiselección botón de radio selección) | Disponible para los siguientes tipos de campo:: -multiselección -botón de radio -seleccionar |
enums[0][sort] | string | Ordenación de valores. | ✅(sólo si actualizas un campo de los tipos: multiselección botón de radio selección) | Disponible para los siguientes tipos de campo:: -multiselección -botón de radio -seleccionar |
nested | array | Arreglo de valores anidados. | ❌ | Disponible para los siguientes tipos de campo: categoría. |
nested[0] | object | Modelos de valores anidados. | ❌ | Disponible para los siguientes tipos de campo: categoría. |
nested[0][id] | int | ID del valor anidado. No debe ser pasado al crear un nuevo valor. | ❌ | Disponible para los siguientes tipos de campo: categoría. |
nested[0][parent_id] | int | ID del valor padre anidado. | ❌ | Disponible para los siguientes tipos de campo: categoría. |
nested[0][value] | string | El valor del valor anidado. | ❌ | Disponible para los siguientes tipos de campo: categoría. |
nested[0][sort] | int | Ordenación del valor anidado. | ❌ | Disponible para los siguientes tipos de campo: categoría. |
nested[0][request_id] | string | Identificador temporal de un valor anidado. El identificador debe ser único para la solicitud, no se guarda en ningún lugar y se utiliza para crear más de un nivel de anidamiento dentro de una misma solicitud. | ❌ | Disponible para los siguientes tipos de campo: categoría. |
nested[0][parent_request_id] | string | Identificador temporal de un valor padre anidado. El identificador se utiliza solo en el momento de la solicitud, no se guarda en ningún lugar y define el nivel de anidamiento del elemento añadido si el elemento padre aún no ha sido creado. | ❌ | Disponible para los siguientes tipos de campo: categoría. |