Visão geral da API
Referência rápida dos recursos disponíveis para integração.
Autenticação
Todos os endpoints protegidos exigem o header:
http
Authorization: Bearer {accessToken}Consulte Autenticação para fluxos completos (login, refresh, API token).
Recursos principais
Notificações
Agende e envie notificações por WhatsApp, Telegram, Discord ou push (FCM).
| Método | Endpoint | Descrição |
|---|---|---|
| POST | /lead-notifications | Criar notificação (única ou recorrente) |
| GET | /lead-notifications | Listar com filtros |
| GET | /lead-notifications/by-lead/:leadId | Notificações de um lead |
| PATCH | /lead-notifications/:id | Atualizar |
| DELETE | /lead-notifications/:id | Cancelar |
| GET | /notification-history | Histórico de entregas |
| PATCH | /notification-history/:id/view | Marcar como vista |
→ Guia completo: Notificações
Calendário / Reuniões
Gerencie reuniões vinculadas a leads.
| Método | Endpoint | Descrição |
|---|---|---|
| POST | /meetings | Criar reunião |
| GET | /meetings?start=&end= | Listar por período |
| GET | /meetings/:id | Detalhe |
| PATCH | /meetings/:id | Atualizar |
| DELETE | /meetings/:id | Excluir |
→ Guia completo: Calendário
Leads
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /leads | Listar (com filtros) |
| GET | /leads/:id | Detalhe |
| POST | /leads | Criar |
| PATCH | /leads/:id | Atualizar (inclui fcmToken) |
| POST | /leads/:id/qualify | Qualificar |
| POST | /leads/:id/fcm-topics | Inscrever em tópico FCM |
→ Guia completo: Leads
Documentação interativa (Swagger)
A referência completa da API está em:
{BASE_URL}/docs
Use o botão "Authorize" para informar seu token e testar os endpoints diretamente.