---
updatedAt: 2025-07-22T09:06:45.000Z
agentTools:
  projectIndex: https://pt-developers.kommo.com/llms.txt
---

# Atualizando campos personalizados

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

**Limitações**\
O método é disponível apenas para usuários administradores.

**Cabeçalho de tipo de dado quando a solicitação é bem-sucedida**\
Content-Type: application/hal+json

**Cabeçalho de tipo de dado em caso de erro**\
Content-Type: application/problem+json

## Parâmetros de resposta

<Table align={["left","left","left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Parâmetro
      </th>

      <th style={{ textAlign: "left" }}>
        Tipo de dado
      </th>

      <th style={{ textAlign: "left" }}>
        Descrição
      </th>

      <th style={{ textAlign: "left" }}>
        Campo obrigatório
      </th>

      <th style={{ textAlign: "left" }}>
        Tipos de campos suportados
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        id
      </td>

      <td style={{ textAlign: "left" }}>
        int
      </td>

      <td style={{ textAlign: "left" }}>
        ID do campo
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os tipos de campos.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        name
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Nome do campo
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os tipos de campos.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        code
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Código do campo que pode ser usado para atualizar o valor sem passar o ID do campo na solicitação.
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os tipos de campos.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        sort
      </td>

      <td style={{ textAlign: "left" }}>
        int
      </td>

      <td style={{ textAlign: "left" }}>
        Ordenação do campo no grupo de campos
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os tipos de campos.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        group\_id
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        ID do grupo de campos
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Available for all lead, contact, company fields
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        is\_api\_only
      </td>

      <td style={{ textAlign: "left" }}>
        bool
      </td>

      <td style={{ textAlign: "left" }}>
        Define se o campo é editável apenas via API
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os campos de Lead, Contato e Empresa.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        required\_statuses
      </td>

      <td style={{ textAlign: "left" }}>
        array|null
      </td>

      <td style={{ textAlign: "left" }}>
        Array dos campos obrigatórios para alterar o status de um lead
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os campos de Lead, Contato e Empresa.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        required\_statuses[0]
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        Modelo de campo obrigatório.
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os campos de Lead, Contato e Empresa.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        required\_statuses[0][status_id]
      </td>

      <td style={{ textAlign: "left" }}>
        int
      </td>

      <td style={{ textAlign: "left" }}>
        ID do estágio que exige um valor no campo antes de mover o lead
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os campos de Lead, Contato e Empresa.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        required\_statuses[0][pipeline_id]
      </td>

      <td style={{ textAlign: "left" }}>
        int
      </td>

      <td style={{ textAlign: "left" }}>
        ID do pipeline que exige um valor no campo antes de mover o lead
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para todos os campos de Lead, Contato e Empresa.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        remind
      </td>

      <td style={{ textAlign: "left" }}>
        string|null
      </td>

      <td style={{ textAlign: "left" }}>
        Configuração de lembretes de aniversário (nunca, dia - dia antes do evento, semana - semana antes do evento, mês - mês antes do evento)
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível apenas para campos de data de nascimento.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        enums
      </td>

      <td style={{ textAlign: "left" }}>
        array
      </td>

      <td style={{ textAlign: "left" }}>
        Array de valores disponíveis para campos com valores enumerados.
      </td>

      <td style={{ textAlign: "left" }}>
        ✅ (apenas se atualizar o campos do tipo:\
        -multiselect\
        -radiobutton\
        -select)
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -multiselect\
        -radiobutton\
        -select
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        enums[0]
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        Modelo de valor disponível.
      </td>

      <td style={{ textAlign: "left" }}>
        ✅ (apenas se atualizar o campos do tipo:\
        -multiselect\
        -radiobutton\
        -select)
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -multiselect\
        -radiobutton\
        -select
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        enums[0][value]
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Valor
      </td>

      <td style={{ textAlign: "left" }}>
        ✅ (apenas se atualizar o campos do tipo:\
        -multiselect\
        -radiobutton\
        -select)
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -multiselect\
        -radiobutton\
        -select
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        enums[0][sort]
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Ordenação de valores.
      </td>

      <td style={{ textAlign: "left" }}>
        ✅(only if you update a field of types:\
        multiselect\
        radiobutton\
        select
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -multiselect\
        -radiobutton\
        -select
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        nested
      </td>

      <td style={{ textAlign: "left" }}>
        array
      </td>

      <td style={{ textAlign: "left" }}>
        Array de valor aninhado
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -categoria
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        nested[0]
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        Modelo de valor aninhado
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -categoria
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        nested[0][id]
      </td>

      <td style={{ textAlign: "left" }}>
        int
      </td>

      <td style={{ textAlign: "left" }}>
        ID do valor aninhado. Não deve ser passado ao criar um novo valor
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -categoria
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        nested[0][parent_id]
      </td>

      <td style={{ textAlign: "left" }}>
        int
      </td>

      <td style={{ textAlign: "left" }}>
        ID do pai do valor aninhado
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -categoria
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        nested[0][value]
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Valor do valor aninhado
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -categoria
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        nested[0][sort]
      </td>

      <td style={{ textAlign: "left" }}>
        int
      </td>

      <td style={{ textAlign: "left" }}>
        Ordenação do valor aninhado
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -categoria
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        nested[0][request_id]
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        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.
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -categoria
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        nested[0][parent_request_id]
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        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.
      </td>

      <td style={{ textAlign: "left" }}>
        ❌
      </td>

      <td style={{ textAlign: "left" }}>
        Disponível para os seguintes tipos de campo:\
        -categoria
      </td>
    </tr>
  </tbody>
</Table>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "referencias-de-api-da-kommo",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://{subdomain}.kommo.com",
      "variables": {
        "subdomain": {
          "default": "subdomain"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/v4/{entity}/custom_fields": {
      "patch": {
        "summary": "Atualizando campos personalizados",
        "description": "Este método permite atualizar múltiplos campos personalizados de uma entidade (leads/contatos/empresas).",
        "operationId": "atualizando-campos-personalizados",
        "parameters": [
          {
            "name": "entity_type",
            "in": "path",
            "description": "Tipo de entidade",
            "schema": {
              "type": "string",
              "enum": [
                "leads",
                "contacts",
                "companies"
              ]
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "RAW_BODY": {
                    "type": "array",
                    "items": {
                      "properties": {
                        "id": {
                          "type": "integer",
                          "description": "ID do campo",
                          "format": "int32"
                        },
                        "name": {
                          "type": "string",
                          "description": "Nome do campo"
                        },
                        "code": {
                          "type": "string",
                          "description": "Código do campo que pode ser usado para atualizar o valor do campo sem passar o ID do campo na solicitação"
                        },
                        "sort": {
                          "type": "integer",
                          "description": "Ordenação do campo no grupo de campos",
                          "format": "int32"
                        },
                        "group_id": {
                          "type": "integer",
                          "description": "ID do grupo de campos",
                          "format": "int32"
                        },
                        "is_api_only": {
                          "type": "boolean",
                          "description": "Define se o campo é editável apenas via API"
                        },
                        "required_statuses": {
                          "type": "array",
                          "description": "Array dos campos obrigatórios para alterar o status de um lead",
                          "items": {
                            "properties": {
                              "status_id": {
                                "type": "integer",
                                "description": "ID da etapa que exige que o campo atual tenha um valor antes que o lead possa ser movido",
                                "format": "int32"
                              },
                              "pipeline_id": {
                                "type": "integer",
                                "description": "ID do pipeline que exige que o campo atual tenha um valor antes que o lead possa ser movido",
                                "format": "int32"
                              }
                            },
                            "type": "object"
                          }
                        }
                      },
                      "type": "object"
                    }
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": [
                    {
                      "id": 624542,
                      "name": "Número de solicitações"
                    },
                    {
                      "id": 1240452,
                      "enums": [
                        {
                          "value": "44",
                          "sort": 2
                        },
                        {
                          "value": "88",
                          "sort": 3
                        },
                        {
                          "value": "22",
                          "sort": 1
                        }
                      ]
                    }
                  ]
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Solicitação bem sucedida": {
                    "value": "{\n    \"_total_items\": 2,\n    \"_embedded\": {\n        \"custom_fields\": [\n            {\n                \"id\": 624542,\n                \"name\": \"Número de solicitações\",\n                \"type\": \"text\",\n                \"account_id\": 32694255,\n                \"code\": null,\n                \"sort\": 501,\n                \"is_api_only\": false,\n                \"enums\": null,\n                \"request_id\": \"0\",\n                \"group_id\": null,\n                \"required_statuses\": [],\n                \"is_deletable\": true,\n                \"is_predefined\": false,\n                \"entity_type\": \"leads\",\n                \"tracking_callback\": null,\n                \"remind\": null,\n                \"triggers\": [],\n                \"currency\": null,\n                \"hidden_statuses\": [],\n                \"chained_lists\": null,\n                \"_links\": {\n                    \"self\": {\n                        \"href\": \"https://subdomain.kommo.com/api/v4/leads/custom_fields/624542\"\n                    }\n                }\n            },\n            {\n                \"id\": 1240452,\n                \"name\": \"Número\",\n                \"type\": \"multiselect\",\n                \"account_id\": 32694255,\n                \"code\": null,\n                \"sort\": 507,\n                \"is_api_only\": false,\n                \"enums\": {\n                    \"3\": {\n                        \"id\": 900900,\n                        \"value\": \"44\",\n                        \"sort\": 2\n                    },\n                    \"4\": {\n                        \"id\": 900902,\n                        \"value\": \"88\",\n                        \"sort\": 3\n                    },\n                    \"5\": {\n                        \"id\": 900904,\n                        \"value\": \"22\",\n                        \"sort\": 1\n                    }\n                },\n                \"request_id\": \"1\",\n                \"group_id\": null,\n                \"required_statuses\": [],\n                \"is_deletable\": true,\n                \"is_predefined\": false,\n                \"entity_type\": \"leads\",\n                \"tracking_callback\": null,\n                \"remind\": null,\n                \"triggers\": [],\n                \"currency\": null,\n                \"hidden_statuses\": [],\n                \"chained_lists\": null,\n                \"_links\": {\n                    \"self\": {\n                        \"href\": \"https://subdomain.kommo.com/api/v4/leads/custom_fields/1240452\"\n                    }\n                }\n            }\n        ]\n    }\n}\n        \n    "
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "_total_items": {
                      "type": "integer",
                      "example": 2,
                      "default": 0
                    },
                    "_embedded": {
                      "type": "object",
                      "properties": {
                        "custom_fields": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "integer",
                                "example": 624542,
                                "default": 0
                              },
                              "name": {
                                "type": "string",
                                "example": "Número de solicitações"
                              },
                              "type": {
                                "type": "string",
                                "example": "text"
                              },
                              "account_id": {
                                "type": "integer",
                                "example": 32694255,
                                "default": 0
                              },
                              "code": {},
                              "sort": {
                                "type": "integer",
                                "example": 501,
                                "default": 0
                              },
                              "is_api_only": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "enums": {},
                              "request_id": {
                                "type": "string",
                                "example": "0"
                              },
                              "group_id": {},
                              "required_statuses": {
                                "type": "array"
                              },
                              "is_deletable": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "is_predefined": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "entity_type": {
                                "type": "string",
                                "example": "leads"
                              },
                              "tracking_callback": {},
                              "remind": {},
                              "triggers": {
                                "type": "array"
                              },
                              "currency": {},
                              "hidden_statuses": {
                                "type": "array"
                              },
                              "chained_lists": {},
                              "_links": {
                                "type": "object",
                                "properties": {
                                  "self": {
                                    "type": "object",
                                    "properties": {
                                      "href": {
                                        "type": "string",
                                        "example": "https://subdomain.kommo.com/api/v4/leads/custom_fields/624542"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Dados inválidos fornecidos. Detalhes estão disponíveis na resposta da solicitação.": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Usuário não autorizado": {
                    "value": "{\n  \"title\": \"Unauthorized\",\n  \"type\": \"https://httpstatus.es/401\",\n  \"status\": 401,\n  \"detail\": \"Nome de usuário ou senha inválidos\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string",
                      "example": "Unauthorized"
                    },
                    "type": {
                      "type": "string",
                      "example": "https://httpstatus.es/401"
                    },
                    "status": {
                      "type": "integer",
                      "example": 401,
                      "default": 0
                    },
                    "detail": {
                      "type": "string",
                      "example": "Nome de usuário ou senha inválidos"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "examples": {
                  "A solicitação não pode ser processada. Detalhes estão disponíveis na resposta da solicitação.": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```