v1

latestOpenAPI 3.1.02026-07-261630686.8 KB

Actualizar un campo personalizado

Este método permite actualizar un campo personalizado singular de una entidad (leads/contactos/compañías).

patch/api/v4/{entity}/custom_fields/{id}

Path parameters

entity_type'leads' | 'contacts' | 'companies' required

Tipo de entidad

idinteger required

ID del campo

Request body

namestring

Nombre del campo

codestring

Código del campo que se puede utilizar para actualizar el valor del campo sin pasar el ID del campo en la solicitud

sortinteger

Ordenación de los campos en el grupo de campos

group_idinteger

ID del grupo de campos

is_api_onlyboolean

Define si el campo es editable solo a través de la API. Disponible para todos los campos de leads, contactos y compañías

remindstring

Disponible solo para los campos de tipo cumpleaños. Configuración de recordatorios de cumpleaños (nunca, mismo día, día antes del evento)

Response

200

idinteger

namestring

typestring

account_idinteger

codestring

sortinteger

is_api_onlyboolean

{"stackTrail":"paths:/api/v4/{entity}/custom_fields/{id}:patch:responses:200:content:application/json:schema:properties:enums","oasType":"schema","type":"unknown"}

request_idstring

catalog_idinteger

is_visibleboolean

is_deletableboolean

is_requiredboolean

{"stackTrail":"paths:/api/v4/{entity}/custom_fields/{id}:patch:responses:200:content:application/json:schema:properties:nested","oasType":"schema","type":"unknown"}

entity_typestring

Example response

{
  "id": 1278898087,
  "name": "Nuevo nombre de campo personalizado",
  "type": "textarea",
  "account_id": 17079858,
  "code": "DESCRIPCIÓN",
  "sort": 560,
  "request_id": "0",
  "catalog_id": 1095,
  "is_deletable": true,
  "entity_type": "catalogs",
  "_links": {
    "self": {
      "href": "https://example.kommo.com/api/v4/leads/custom_fields/1278898087"
    }
  }
}