Skip to main content

​
Conceito

Custom Fields permitem que você adicione campos extras ao perfil dos contatos no CRM da Timely.ai, além dos campos padrão como nome, email e telefone. São úteis quando você precisa armazenar informações específicas do seu negócio — número de pedido, plano contratado, segmento de cliente, data da última compra, CPF, nome da empresa, entre outros. Os campos são definidos no nível do workspace e se aplicam a todos os contatos. Cada campo tem um tipo de dado (texto, número, data, booleano, seleção) e pode ser marcado como obrigatório ou opcional. Os valores dos campos de cada contato são acessados via contact.custom_fields na API de Contacts.

​
Tipos de campo disponíveis

TipoValor em typeExemplo de uso
Texto livretextObservações, número de protocolo
NúmeronumberValor do contrato, quantidade de pedidos
DatadateData de aniversário, vencimento
BooleanobooleanVIP, inadimplente, newsletter
Seleção únicaselectSegmento, plano, status
Seleção múltiplamultiselectInteresses, produtos contratados

​
Campos principais

CampoTipoDescrição
idstring (UUID)ID único do campo
namestringNome do campo (exibido na UI)
keystringChave de acesso via API (snake_case)
typeenumTipo do dado do campo
requiredbooleanSe o campo é obrigatório
optionsarrayOpções disponíveis para select e multiselect
default_valueanyValor padrão para novos contatos
created_atstringISO 8601 de criação

​
Como usar em conjunto com Contacts

Ao criar ou atualizar um contato, passe os valores dos campos personalizados no objeto custom_fields usando a key de cada campo: 
{
  "name": "Lucas Ferreira",
  "email": "lucas@empresa.com.br",
  "custom_fields": {
    "plano": "pro",
    "numero_cliente": "CLT-00123",
    "vip": true
  }
}

​
Endpoints disponíveis

Consulte a barra lateral à esquerda para a lista completa de endpoints deste grupo. Cada endpoint tem sua própria página com schema de request/response, exemplos em cURL/JS/Python e playground interativo.

​
Próximos passos

Primeira requisição

Se você ainda não fez sua primeira chamada, comece por aqui.