---
title: "Atualizando campos personalizados"
method: PATCH
path: "/api/v4/{entity}/custom_fields"
---

# Atualizando campos personalizados

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

## Request

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

Este método permite atualizar múltiplos campos personalizados de uma entidade (leads/contatos/empresas).

## Path parameters

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

## Request body

- object
  - `RAW_BODY` object[]
    - `id` integer: ID do campo
    - `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
    - `required_statuses` object[]: Array dos campos obrigatórios para alterar o status de um lead
      - `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

## Response `200`

200

- object
  - `_total_items` integer
  - `_embedded` object
    - `custom_fields` object[]
      - `id` integer
      - `name` string
      - `type` string
      - `account_id` integer
      - `code` unknown
      - `sort` integer
      - `is_api_only` boolean
      - `enums` unknown
      - `request_id` string
      - `group_id` unknown
      - `required_statuses` unknown[]
        - unknown
      - `is_deletable` boolean
      - `is_predefined` boolean
      - `entity_type` string
      - `tracking_callback` unknown
      - `remind` unknown
      - `triggers` unknown[]
        - unknown
      - `currency` unknown
      - `hidden_statuses` unknown[]
        - unknown
      - `chained_lists` unknown
      - `_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)