API Reference

Campos personalizados

No Atendare, você pode realizar a criação de campos personalizados para adicionar informações customizadas sobre seu processo. Os campos personalizados estão disponíveis em contatos, empresas, qualificações, negociações e projetos.

Para utilizar esses campos via API basta acrescentar o identificador do campo junto aos demais campos.

📘

Nota

Todos os campos personalizados iniciam com o prefixo custom_
Por exemplo:

custom_cidade_natal
custom_cor_preferida

Exemplo

{
  name: "Nome do Contato",
  custom_cidade_natal: "Tres de Maio",
  custom_cor_preferida: "Azul"
}

No exemplo acima, o campo name é nativo do sistema enquanto os demais são personalizados.

Tipos de Campos

Esses campos podem ser de diferentes tipos, sendo eles:

Tipo de campoDescrição
Texto curtoTipo de campo que recebe qualquer tipo de texto curto
Texto longoTipo de campo que recebe qualquer tipo de texto longo
Numérico inteiroTipo de campo que recebe apenas números inteiros
Numérico decimalTipo de campo que recebe apenas números decimais
DataTipo de campo que recebe alguma data (enviado no formato YYYY-MM-DD)
HoraTipo de campo que recebe algum horário (enviado no formato HH:mm)
Data e horaTipo de campo que recebe as informações de data e hora (YYYY-MM-DD HH:mm)
Múltipla escolhaTipo de campo que contém uma lista de opções permitindo a seleção de apenas uma opção
Caixa de seleçãoTipo de campo que contém uma lista de opções permitindo a seleção de mais de uma opção
Lista suspensaTipo de campo que contém uma lista de opções permitindo a seleção de apenas uma opção
URLTipo de campo que recebe uma URL
E-mailTipo de campo que recebe apenas e-mail
TelefoneTipo de campo que recebe apenas telefone