Pular para o conteúdo principal

​
Criar Definição

POST /backend/custom-fields

​
Request Body

​
field_key
string
obrigatório
Chave única do campo (usada em variáveis)
​
field_label
string
obrigatório
Rótulo exibido na interface
​
field_description
string
Descrição do campo
​
field_type
string
obrigatório
Tipo: text, number, date, boolean, select
​
options
array
Opções disponíveis (obrigatório para tipo select)
​
required
boolean
padrão:"false"
Se o campo é obrigatório
​
default_value
any
Valor padrão
​
display_order
integer
Ordem de exibição
curl -X POST "https://api.leavo.ai/backend/custom-fields" \
  -H "Authorization: Bearer sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "field_key": "origem_lead",
    "field_label": "Origem do Lead",
    "field_description": "Como o lead chegou até nós",
    "field_type": "select",
    "options": ["Site", "Indicação", "Evento", "Anúncio", "Outro"],
    "required": false,
    "default_value": "Site",
    "display_order": 1
  }'

{
  "id": "uuid",
  "tenant_id": "uuid",
  "field_key": "origem_lead",
  "field_label": "Origem do Lead",
  "field_description": "Como o lead chegou até nós",
  "field_type": "select",
  "options": ["Site", "Indicação", "Evento", "Anúncio", "Outro"],
  "required": false,
  "default_value": "Site",
  "display_order": 1,
  "is_active": true,
  "created_at": "2024-01-01T00:00:00Z"
}

​
Listar Definições

GET /backend/custom-fields

​
Query Parameters

​
active_only
boolean
padrão:"false"
Filtrar apenas campos ativos
curl -X GET "https://api.leavo.ai/backend/custom-fields?active_only=true" \
  -H "Authorization: Bearer sua_chave_aqui"

​
Obter Variáveis

GET /backend/custom-fields/variables
Retorna todas as variáveis disponíveis para uso em prompts e mensagens. 
{
  "standard_variables": [
    {"key": "{{LEAD_NAME}}", "description": "Nome completo do lead"},
    {"key": "{{LEAD_FIRSTNAME}}", "description": "Primeiro nome do lead"},
    {"key": "{{LEAD_NUMBER}}", "description": "Telefone do lead"},
    {"key": "{{COMPANY_NAME}}", "description": "Nome da empresa"}
  ],
  "custom_variables": [
    {"key": "{{LEAD_ORIGEM_LEAD}}", "label": "Origem do Lead", "type": "select"}
  ]
}

​
Atualizar/Deletar Definição

PUT /backend/custom-fields/{id}

DELETE /backend/custom-fields/{id}
​
id
string
obrigatório
UUID da definição do campo
Deletar uma definição remove todos os valores salvos para esse campo em todos os leads.