latestOpenAPI 3.0.12026-08-1914141.6 MB
c656412a58bc
Solicitantes
Atualizar campos personalizados do solicitante
Esta rota permite a atualização dos campos personalizados associados a um solicitante específico.
Para consultar quais campos personalizados estão disponíveis para o solicitante em questão, utilize o método Exibir solicitante.
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" |
| 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
put/clients/{client_id}/requestors/{id}/entities
Path parameters
client_idinteger required
ID do cliente
idinteger required
ID do solicitante
Request body
Response
Campos personalizados atualizados com sucesso
O corpo da resposta dessa requisição será um objeto requestor contendo informações básicas do solicitante e outro objeto requestor_entities, contendo todos os campos personalizados dele após a atualização