Introdução
URL base
A API do Madmail segue os princípios REST e é servida por HTTPS. Para garantir a privacidade dos dados, HTTP sem criptografia não é suportado.
A URL base de todos os endpoints é:
https://app.madmail.com.br/api/
Autenticação
A autenticação na API do Madmail é feita pelo cabeçalho Authorization com um
token Bearer. Inclua o cabeçalho com a palavra Bearer seguida do seu token:
Authorization: Bearer us_12345
Você cria um token/chave de API nas Configurações de desenvolvedor do Madmail.
Conector de IA (MCP)
Além da API REST, o Madmail expõe um servidor MCP (Model Context Protocol) — o padrão aberto que permite que assistentes como o ChatGPT e o Claude usem ferramentas externas. É assim que você dispara conversando: você descreve a campanha, o assistente executa no Madmail.
Você não precisa escrever código para usar o MCP. Basta conectar o seu assistente ao endereço abaixo e autorizar o acesso à sua conta.
Endpoint
https://mcp.madmail.com.br/mcp
A autorização é feita por OAuth: ao conectar, o assistente abre a tela de login do Madmail e você aprova o acesso. Nenhuma chave é copiada manualmente, e você pode revogar o acesso quando quiser em Configurações de desenvolvedor.
O que o assistente consegue fazer
list_contacts, import_contacts, list_lists, create_list
create_segment, preview_segment, materialize_segment,
list_segments, delete_segment
create_campaign, schedule_campaign, send_campaign,
pause_campaign, resume_campaign, list_campaigns,
get_campaign_report
list_templates, get_template, save_template, render_preview
send_email, get_email, cancel_email
list_domains, get_domain
get_analytics, get_usage, get_reputation_status,
get_bounce_breakdown
O assistente propõe as ações; o disparo real só acontece com a sua confirmação. As permissões seguem o escopo autorizado no login.