Docs/API Reference/Campanhas
DashboardGitHub

Campanhas são o coração da cobrança automatizada. Cada campanha agrupa dívidas, define a estratégia de abordagem e controla o ciclo de vida do contato com devedores.

Endpoints

#
MétodoEndpointDescrição
POST/api/campaignsCriar campanha
GET/api/campaignsListar campanhas (paginado)
GET/api/campaigns/:id/statsEstatísticas da campanha
GET/api/campaigns/:id/previewPreview de dívidas que serão contactadas
POST/api/campaigns/:id/launchLançar campanha
POST/api/campaigns/:id/pausePausar campanha
PUT/api/campaigns/:id/archiveArquivar/desarquivar campanha
GET/api/campaigns/:id/debtsListar dívidas da campanha (paginado)
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN).


Criar campanha

POST/api/campaigns

Cria uma nova campanha de cobrança. A campanha é criada com status DRAFT e precisa ser lançada separadamente.


Listar campanhas

GET/api/campaigns

Retorna a lista paginada de campanhas do cliente autenticado. Suporta filtros por status e ordenação por data de criação.


Estatísticas da campanha

GET/api/campaigns/:id/stats

Retorna KPIs da campanha: total de dívidas, valor pendente, taxa de recuperação, conversas ativas e pagamentos confirmados.


Preview de dívidas

GET/api/campaigns/:id/preview

Retorna uma amostra das dívidas que serão contactadas quando a campanha for lançada. Útil para validar filtros antes do disparo.


Lançar campanha

POST/api/campaigns/:id/launch

Altera o status da campanha para ACTIVE e inicia o envio de mensagens via WhatsApp. Essa ação não pode ser desfeita, apenas pausada.


Pausar campanha

POST/api/campaigns/:id/pause

Pausa uma campanha ativa. Novas mensagens não serão enviadas, mas conversas em andamento continuam respondendo.


Arquivar/desarquivar campanha

PUT/api/campaigns/:id/archive

Alterna o estado de arquivamento da campanha. Campanhas arquivadas não aparecem na listagem padrão.


Listar dívidas da campanha

GET/api/campaigns/:id/debts

Retorna a lista paginada de dívidas vinculadas à campanha, incluindo status de contato e pagamento de cada uma.