---
title: "Atualizando um único campo personalizado"
method: PATCH
path: "/api/v4/{entity}/custom_fields/{id}"
---

# Atualizando um único campo personalizado

`PATCH /api/v4/{entity}/custom_fields/{id}`

## Request

- Base URL: `https://subdomain.kommo.com`
- URL: `https://subdomain.kommo.com/api/v4/{entity}/custom_fields/{id}`
- Auth: OAuth 2

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

## Path parameters

- `entity_type` 'leads' | 'contacts' | 'companies', required
- `id` integer, required

## Request body

- object
  - `name` string: Nome do campo
  - `code` string: Código do campo que pode ser usado para atualizar o valor do campo sem passar o ID do campo na solicitação
  - `sort` integer: Ordenação do campo no grupo de campos
  - `group_id` integer: ID do grupo de campos
  - `is_api_only` boolean: Define se o campo é editável apenas via API. Disponível para todos os campos de lead, contato e empresa.
  - `required_statuses` object[]: Array of the fields required to change a lead status
    - `status_id` integer: ID da etapa que exige que o campo atual tenha um valor antes que o lead possa ser movido
    - `pipeline_id` integer: ID do pipeline que exige que o campo atual tenha um valor antes que o lead possa ser movido
  - `remind` string: 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)
  - `enums` object[]: Disponível para os seguintes tipos de campo: multiselect, radiobutton e select
    - `value` string: Valor
    - `sort` integer: Ordenação dos valores
    - `code` string: Código simbólico do valor
  - `nested` object[]: Array de valores aninhados. Disponível para os seguintes tipos de campo: categoria
    - `id` integer: ID do valor aninhado. Não deve ser passado ao criar um novo valor
    - `parent_id` integer: ID do pai do valor aninhado
    - `value` string: Valor do valor aninhado
    - `sort` integer: Ordenação do valor aninhado
    - `request_id` string: Identificador temporário de um valor aninhado. O identificador deve ser único para a solicitação, não é salvo em nenhum lugar e é usado para criar mais de um nível de aninhamento dentro de uma solicitação.
    - `parent_request_id` string: Identificador temporário do pai de um valor aninhado. O identificador é usado apenas no momento da solicitação, não é salvo em nenhum lugar e define o nível de aninhamento do elemento adicionado caso o elemento pai ainda não tenha sido criado.

## Response `200`

200

- object
  - `_total_items` integer
  - `_embedded` object
    - `custom_fields` object[]
      - `id` integer
      - `name` string
      - `type` string
      - `account_id` integer
      - `code` string
      - `sort` integer
      - `is_api_only` boolean
      - `enums` unknown
      - `request_id` string
      - `catalog_id` integer
      - `is_visible` boolean
      - `is_deletable` boolean
      - `is_required` boolean
      - `nested` unknown
      - `entity_type` string
      - `_links` object
        - `self` object
          - `href` string

## Other responses

- `400`: 400
- `401`: 401
- `422`: 422

---

[API](https://skmtc.dev/kommo/apis/referencias-de-api-da-kommo.md) - [All operations](https://skmtc.dev/kommo/apis/referencias-de-api-da-kommo/llms.txt) - [OpenAPI document](https://skmtc.dev/kommo/apis/referencias-de-api-da-kommo/revisions/55101699dddb?raw)