Sign in

v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Atualizando um único campo personalizado

Este método permite atualizar um único campo personalizado de uma entidade (leads/contatos/empresas).

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

Path parameters

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

Tipo de entidade

idinteger required

ID do campo

Request body

namestring

Nome do campo

codestring

Código do campo que pode ser usado para atualizar o valor do campo sem passar o ID do campo na solicitação

sortinteger

Ordenação do campo no grupo de campos

group_idinteger

ID do grupo de campos

is_api_onlyboolean

Define se o campo é editável apenas via API. Disponível para todos os campos de lead, contato e empresa.

remindstring

Disponível apenas para campos do tipo data de nascimento. Configuração de lembretes de aniversário (nunca, dia – um dia antes do evento, semana – uma semana antes do evento, mês – um mês antes do evento)

Response

200

_total_itemsinteger

Example response

{
  "_total_items": 1,
  "_embedded": {
    "custom_fields": [
      {
        "id": 1278898087,
        "name": "Nome do novo campo personalizado",
        "type": "textarea",
        "account_id": 17079858,
        "code": "DESCRIÇÃO",
        "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"
          }
        }
      }
    ]
  }
}