Skip to main content
GET
/
api
/
user-databases
/
{id}
/
records
curl -X POST https://api.disparador.com/api/user-databases/42/records \\
  -H "Content-Type: application/json" \\
  -H "X-Access-Token: seu-access-token" \\
  -d '{
    "values": {
      "phone": "+5511999999999",
      "name": "João da Silva",
      "origem": "Landing Page"
    }
  }'
{
  "id": 5,
  "values": {
    "phone": "+5511999999999",
    "name": "João da Silva",
    "origem": "Formulário WhatsApp"
  },
  "createdAt": "2025-02-10T12:00:00Z",
  "updatedAt": "2025-02-12T09:30:00Z"
}

Listar registros

GET /api/user-databases/{databaseId}/records

Query params

page
number
default:"0"
Página (0-index)
size
number
default:"25"
Quantidade de itens por página (10, 25, 50 ou 100 são recomendados)
sortBy
string
default:"id"
id, created_at, updated_at ou qualquer columnName existente
sortDirection
string
default:"DESC"
Direção da ordenação
Busca textual aplicada ao ID e a todas as colunas textuais
content
array
Lista de registros, cada um com id, values, createdAt e updatedAt
totalElements
number
Quantidade total de registros no banco
totalPages
number
Total de páginas baseado em size
size
number
Itens por página retornados nesta chamada
number
number
Página atual (0-index)

Buscar um registro

GET /api/user-databases/{databaseId}/records/{recordId} retorna o registro completo, útil para preencher o modal de edição.

Criar ou atualizar registros

Criar

POST /api/user-databases/{databaseId}/records
values
object
required
Objeto dinâmico onde cada chave precisa corresponder a um columnName do banco. Exemplos: {"phone":"5511999999999","name":"Cliente"}.

Atualizar

PUT /api/user-databases/{databaseId}/records/{recordId} usa a mesma estrutura de body. Campos omitidos permanecem com o valor anterior.
curl -X POST https://api.disparador.com/api/user-databases/42/records \\
  -H "Content-Type: application/json" \\
  -H "X-Access-Token: seu-access-token" \\
  -d '{
    "values": {
      "phone": "+5511999999999",
      "name": "João da Silva",
      "origem": "Landing Page"
    }
  }'
{
  "id": 5,
  "values": {
    "phone": "+5511999999999",
    "name": "João da Silva",
    "origem": "Formulário WhatsApp"
  },
  "createdAt": "2025-02-10T12:00:00Z",
  "updatedAt": "2025-02-12T09:30:00Z"
}

Excluir registro

DELETE /api/user-databases/{databaseId}/records/{recordId} remove permanentemente o contato.
Não há histórico ou desfazer. Certifique-se de exportar os dados antes de exclusões em massa.