---
title: "Atualizar campos personalizados do cliente"
method: PUT
path: "/clients/{id}/entities"
tags: ["Clientes"]
---

# Atualizar campos personalizados do cliente

`PUT /clients/{id}/entities`

Esta rota permite a atualização dos campos personalizados associados a um cliente específico.

Para consultar quais campos personalizados estão disponíveis para o cliente em questão, utilize o método [Exibir cliente](#get-/clients/-id-).
### **Descrição dos valores aceitos**
O formato do valor do campo (`value`) deve ser compatível com o tipo de campo personalizado (`entity_field_id`) que está sendo atualizado. Consulte a tabela abaixo para obter exemplos de valores válidos para cada tipo de campo:
Tipo de campo | Descrição | Exemplos
--- | --- | ---
text | Aceita qualquer valor de string | `"Meu texto"`
text_area | Aceita qualquer valor de string | `"Meu texto de exemplo"`
currency | Aceita uma string de números float utilizando o ponto como separador decimal e sem agrupador de milhares | `"1200.55"`,`"15"`
phone | Aceita uma string de números inteiros, representando o número de telefone sem o código do país (DDI). Por padrão, o sistema vai tentar validar esse telefone como um número brasileiro. Se você deseja inserir um número de outro país, será necessário utilizar o atributo `country_code` junto no corpo da sua requisição | `"47999999999"`
email | Aceita uma string com o e-mail | `"suporte@tiflux.com"`
link | Aceita uma string contendo o endereço do link. O link deve começar com http, https ou ftp, para ser considerado como válido | `"https://guia-de-uso.tiflux.com/"`
date | Aceita uma string contendo a data. Serão aceitas datas em vários formatos (inclusive com horas). Porém, o valor será gravado em banco da seguinte forma: "YYYY-MM-DD", sendo assim, recomendamos que você informe a data nesse padrão também | `"2025-05-28"`
single_select | Aceita uma string contendo um número inteiro com o ID da nova opção que foi escolhida | `"777"`, `"52"`
checkbox | Aceita uma string contendo um valor booleano representando se você deseja marcar o checkbox ("true") ou desmarcá-lo ("false") | `"true"`, `"false"`

- **Observação:** Se você deseja apagar/limpar o valor de um campo personalizado que não é obrigatório, basta informar o atributo value como null: `"value": null`

## Path parameters

- `id` integer, required

## Request body

- Entities
  - `entities` object[]
    - `entity_field_id` integer, required — Identificador único do campo da entidade que será atualizada
    - `entity_field_option_id` integer, nullable — Identificador da opção do campo personalizado a ser atualizado. Este atributo só deve ser informado para campos do tipo `checkbox`
    - `value` string, nullable — Novo valor do campo personalizado. O formato específico de como o valor dessa string deve ser preenchido, depende do tipo de campo personalizado. Consulte a documentação para obter mais detalhes
    - `country_code` string — Código de país no formato <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2" target="_blank">ISO 3166-1 alpha-2</a> Este atributo será utilizado para validar se o número de telefone informado é um número válido no país informado. Esse atributo só será utilizado ao atualizar um campo personalizado do tipo `phone`

## Response `200`

### **Campos personalizados atualizados com sucesso**
O corpo da resposta dessa requisição será um objeto `client` contendo informações básicas do cliente e outro objeto `entities`, contendo todos os campos personalizados dele após a atualização

- object
  - `client` object
    - `id` integer — ID do cliente
    - `name` string — Nome do cliente
    - `social` string — Razão social
    - `social_revenue` string, nullable — CPF/CNPJ
  - `entities` object[]
    - `id` integer — ID do campo personalizado
    - `active` boolean — O campo personalizado está ativo?
    - `applied_in` string — Onde o campo personalizado está aplicado/configurado
    - `description` string, nullable — Descrição do campo personalizado
    - `menu_item` boolean, nullable — É um item de menu?
    - `name` string — Nome do campo personalizado
    - `entity_fields` object[] — **Lista de campos, dos campos personalizados vinculados nesse objeto**
      - `id` integer, nullable — Identificador do valor preenchido
      - `field_type` 'email' | 'date' | 'currency' | 'phone' | 'checkbox' | 'text' | 'text_area' | 'single_select' | 'link' — Tipos de campo: "**email**", "**date**", "**currency**", "**phone**", "**checkbox**", "**text**", "**text_area**", "**single_select**", "**link**"
      - `name` string — Nome do campo
      - `required` boolean — Informa se o campo é de preenchimento obrigatório
      - `entity_field_id` integer — Identificador do campo
      - `entity_id` integer — Identificador do campo personalizado
      - `value` string, nullable — Valor preenchido
      - `options` object[] — **Lista com valores das opções preenchidas no campo** (utilizado em campos do tipo checkbox e single_select)
        - `id` integer — Identificador do valor preenchido
        - `entity_field_id` integer — Identificador do campo
        - `entity_field_option_id` integer — Identificador da opção
        - `title` string — Nome da opção
        - `value` string — Valor da opção

## Other responses

- `207` — ### **Sucesso Parcial na Atualização de Campos Personalizados** Este código de resposta indica que a requisição para atualizar campos personalizados foi **parcialmente bem-sucedida**. Ou seja, alguns dos campos podem ter sido atualizados com sucesso, enquanto outros apresentaram falhas e não foram atualizados. Para os campos que apresentaram falhas na atualização, o motivo do erro está detalhado no atributo `detail`. Se um campo não constar na listagem de erros, significa que ele foi atualizado com sucesso.
- `400` — ### **Parâmetro inválido encontrado** Você informou algum atributo inválido ou fora do padrão dessa requisição. Confira os exemplos e o schema, para garantir que o corpo da sua requisição esteja no formato correto
- `403` — ### **Problemas com permissão** Essa resposta significa que o seu grupo de permissões não possui a permissão necessária para acessar essa rota
- `404` — ### **Cliente não encontrado**

---

[API](https://skmtc.net/tiflux/apis/tiflux-official-api.md) · [All operations](https://skmtc.net/tiflux/apis/tiflux-official-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tiflux/tiflux-official-api/revisions/c656412a58bc/schema)