Docs/API Reference/Importar Dívidas
DashboardGitHub

Importe dívidas para uma campanha usando o formato mais conveniente para o seu sistema. Todos os métodos validam campos obrigatórios (CPF, valor, vencimento) e retornam erros detalhados por linha.

Endpoints

#
MétodoEndpointDescrição
POST/api/import/json/:campaignIdImportar via JSON
POST/api/import/upload/:campaignIdImportar via CSV (10 MB)
POST/api/import-api/apiImportar via API Key (ERP, 5K max)
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN), exceto o endpoint de API Key que usa x-api-key no header.

Importar via JSON

POST/api/import/json/:campaignId

Recebe um array de dívidas no corpo da requisição. Ideal para integrações programáticas e testes.

Importar via CSV

POST/api/import/upload/:campaignId

Upload de arquivo CSV com limite de 10 MB. O arquivo deve conter headers na primeira linha. Campos obrigatórios: cpf, nome, telefone, valor, vencimento.

⚠️

O encoding do arquivo deve ser UTF-8. Arquivos com encoding ISO-8859-1 podem causar erros em nomes com acentos.

Importar via API Key (ERP)

POST/api/import-api/api

Endpoint destinado a integrações com ERPs (Omie, TOTVS, Conta Azul). Usa autenticação via header x-api-key em vez de JWT. Limite de 5.000 registros por requisição.