Documentação da API para desenvolvedores

Primeiros passos

Todos os planos pagos incluem acesso completo à API REST. Gere uma chave na sua conta, em Conta → Chaves de API, e envie-a em cada requisição:

curl -H "X-Api-Key: YOUR_KEY" https://mailflow.top/api/index.php/lists

URL base: https://mailflow.top/api/index.php · As respostas são em JSON, com um campo status de valor success ou error. A API não está disponível no plano gratuito.

Recursos principais

A plataforma é compatível com o MailWizz, por isso toda a API principal — listas, assinantes, segmentos, campos personalizados, campanhas, rastreamento, modelos, e-mail transacional, bounces, cancelamentos de inscrição — está documentada de forma interativa (OpenAPI) em:

→ Referência interativa da API (OpenAPI)

Os SDKs existentes do MailWizz (por exemplo, o SDK oficial para PHP) funcionam imediatamente — basta apontá-los para a URL base acima.

Endpoints de IA

Os recursos de IA são cidadãos de primeira classe na API. A mesma chave, a mesma autenticação e os mesmos limites de plano e medição de créditos do aplicativo web.

GET /ai/credits

Seu medidor de créditos de IA do mês atual. Os créditos valem por mês de cobrança, e os créditos não utilizados não são acumulados.

{"status":"success","data":{"unlimited":false,"limit":750,"used":112,"remaining":638}}

GET /ai/replies

Classificações do Smart Replies para suas campanhas — alimente seu CRM com quem tem interesse, quem fez uma pergunta e quem reclamou. Filtros: category (interested, question, complaint, unsubscribe_request, auto_reply, out_of_office, bounce, other), campaign_uid, since (YYYY-MM-DD), page, per_page (máx. 50).

curl -H "X-Api-Key: YOUR_KEY" \
  "https://mailflow.top/api/index.php/ai/replies?category=interested&since=2026-08-01"

{"status":"success","data":{"count":42,"current_page":1,"per_page":20,"total_pages":3,
  "records":[{"from_email":"[email protected]","subject":"RE: your offer",
    "category":"interested","confidence":98,"engine":"embeddings",
    "summary":"...","suggested_reply":"...","date_added":"2026-08-24 18:21:19",
    "campaign_uid":"py794hjqk8a8d"}]}}

GET /ai/tiers

Níveis de engajamento por IA (vip, engaged, passive, at_risk, dormant) por lista — a mesma pontuação que alimenta o piloto automático e a reconquista.

{"status":"success","data":{"records":[
  {"list_uid":"qk661oq7nl8c1","name":"Main list","tiers":{"engaged":1200,"passive":3400,"dormant":900}}]}}

POST /ai/subject-lines

Gere linhas de assunto em qualquer idioma. Corpo: topic (obrigatório), count (1–5, padrão 3), language (opcional). Consome créditos de IA como o editor web.

curl -X POST -H "X-Api-Key: YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"topic":"Summer sale for B2B customers","count":3,"language":"Greek"}' \
  https://mailflow.top/api/index.php/ai/subject-lines

{"status":"success","data":{"subjects":["...","...","..."],"credits_remaining":636}}

GET /ai/flows · POST /ai/flows/author · POST /ai/flows/<uid>/enroll · POST /ai/flows/<uid>/status

Criador de fluxos com IA via API: liste seus fluxos com contadores em tempo real; peça à IA que crie um fluxo completo a partir de um objetivo em linguagem simples ({"goal":"...","list_uid":"..."} — retorna um rascunho que você ativa com {"status":"active"}); insira um assinante em um fluxo ({"email":"..."}).

curl -X POST -H "X-Api-Key: YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"goal":"When someone replies interested, notify me, wait 2 days, then send a case study"}' \
  https://mailflow.top/api/index.php/ai/flows/author

Erros e limites

401 — X-Api-Key ausente ou inválido
403 — o recurso não está incluído no seu plano
422 — parâmetros ausentes/inválidos
429 — limite de créditos de IA ou cota mensal de IA atingido; renova na sua próxima data de cobrança

Picos de requisições são limitados por chave — implemente backoff exponencial ao receber 429. Dúvidas? Fale conosco ou abra um ticket de suporte.

API para desenvolvedores