Skip to main content
POST
/
api
/
user-databases
curl -X POST https://api.disparador.com/api/user-databases \\
  -H "X-Access-Token: seu-access-token" \\
  -F "[email protected]" \\
  -F 'config={"name":"Clientes VIP","description":"Renovações","columnMappings":[{"originalName":"telefone","displayName":"Telefone","dataType":"text","isPhoneColumn":true}]};type=application/json'

{
  "id": 77,
  "name": "Contatos Evolution",
  "origin": "EVOLUTION",
  "status": "ACTIVE",
  "rowCount": 982,
  "lastSyncedAt": "2025-02-10T14:20:00Z",
  "lastSyncSummary": {
    "totalFetched": 1200,
    "processed": 982,
    "duplicatesSkipped": 38,
    "filteredByPhone": 80
  }
}
Todos os endpoints abaixo exigem X-Access-Token válido. O tamanho máximo do arquivo depende do plano contratado.

​
Analisar arquivo

POST /api/user-databases/analyze Use este endpoint antes do upload definitivo para mapear colunas automaticamente.

​
Headers

​
Content-Type
string
required
multipart/form-data

​
Body

​
file
file
required
Arquivo CSV ou XLSX com cabeçalho na primeira linha

​
Response

​
columns
array
Nomes detectados no cabeçalho
​
rowCount
number
Número estimado de linhas válidas
​
sampleData
object
Até 5 amostras por coluna para ajudar no mapeamento
​
warnings
array
Alertas (colunas repetidas, formatos desconhecidos etc.)

​
Criar banco via upload

POST /api/user-databases Envie o arquivo final e a configuração de colunas no mesmo multipart. O campo config deve ser um JSON.

​
Body

​
file
file
required
Arquivo CSV/XLSX definitivo
​
config
object
required
JSON com as opções abaixo
​
config.name
string
required
Nome exibido na UI
​
config.description
string
Texto auxiliar sobre o objetivo do banco
​
config.columnMappings
array
required
Lista de colunas e metadados
curl -X POST https://api.disparador.com/api/user-databases \\
  -H "X-Access-Token: seu-access-token" \\
  -F "[email protected]" \\
  -F 'config={"name":"Clientes VIP","description":"Renovações","columnMappings":[{"originalName":"telefone","displayName":"Telefone","dataType":"text","isPhoneColumn":true}]};type=application/json'

​
Sincronizar com Evolution

POST /api/user-databases/evolution/sync Cria um novo banco ou atualiza um existente a partir da Evolution API.
​
databaseId
number
Informe para atualizar um banco existente; omita para criar um novo
​
evolutionConfigId
number
required
Configuração Evolution previamente salva (contém URL/API Key/instância)
​
name
string
Nome do banco; obrigatório ao criar um novo
​
description
string
Observações sobre o sincronismo
​
includeGroups
boolean
Importa grupos e não apenas contatos individuais
​
includeGroupMembers
boolean
Importa membros dos grupos selecionados
​
includeUnsavedContacts
boolean
Captura contatos não salvos na agenda
​
includeContactsWithoutPhone
boolean
Mantém registros mesmo sem telefone (útil para enriquecimento)
​
deduplicate
boolean
default:"true"
Remove duplicados automaticamente
{
  "id": 77,
  "name": "Contatos Evolution",
  "origin": "EVOLUTION",
  "status": "ACTIVE",
  "rowCount": 982,
  "lastSyncedAt": "2025-02-10T14:20:00Z",
  "lastSyncSummary": {
    "totalFetched": 1200,
    "processed": 982,
    "duplicatesSkipped": 38,
    "filteredByPhone": 80
  }
}