arrobaMail
Testar grátis
REST API v3

Email Marketing, programável

REST sobre JSON, autenticação JWT, 11 módulos, mais de 100 endpoints documentados. Conecte o arrobaMail à sua stack em minutos.

  • 100+
    Endpoints
  • 11
    Módulos
  • JWT
    Auth
Experimente a API grátisVer Quickstart

O Plano Gratuito funciona como sandbox: conta real com todas as funções, API e MCP incluídos, sem cartão.

curl · exemplo
# 1. Obtenha seu token JWT
curl -X POST https://envios.arrobamail.com/v3/api/auth/getToken \
  -H "Content-Type: application/json" \
  -d '{"username":"suaconta","pass":"***"}'

# 2. Liste as campanhas ativas
curl https://envios.arrobamail.com/v3/api/campaigns?status=active \
  -H "Authorization: Bearer eyJhbGciOi..."

# 3. Dispare uma campanha para suas listas
curl -X POST https://envios.arrobamail.com/v3/api/campaigns \
  -H "Authorization: Bearer eyJhbGciOi..." \
  -d '{"camp_name":"Promo de abril","asunto":"Chegou a promoção","html":"<h1>Olá</h1>","from_name":"Sua empresa","from_mail":"[email protected]","list_id":["1A2B3C"]}'
Quickstart

Do zero ao primeiro envio em 3 requests

Sem SDK nem bibliotecas próprias: REST sobre JSON a partir da sua stack. Escolha sua linguagem e siga os três passos.

  1. 01Passo 1

    Consiga seu token JWT

    Com seu usuário e senha, POST /auth/getToken retorna um token Bearer que você vai usar no restante das chamadas. Suporta rememberMe para durar até 365 dias.

    curl
    curl -X POST https://envios.arrobamail.com/v3/api/auth/getToken \
  -H "Content-Type: application/json" \
  -d '{"username":"tucuenta","pass":"***"}'

# 200 OK
# { "token": "eyJhbGciOi..." }
  2. 02Passo 2

    Verifique um remetente

    O remetente (from) precisa estar verificado antes de enviar. Ao criá-lo, a arrobaMail roda as checagens de DNS (SPF/DKIM) caso não seja um e-mail gratuito.

    curl
    curl -X POST https://envios.arrobamail.com/v3/api/senders \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from_name":"Tu empresa","from_mail":"[email protected]"}'

# 200 OK
# { "status": "ok", "spf": true, "dkim": true }
  3. 03Passo 3

    Lance sua primeira campanha

    Uma chamada POST com o nome, o assunto, o HTML, o remetente e a lista enfileira o envio. Adicione track_reads e track_links para medir aberturas e clicks.

    curl
    curl -X POST https://envios.arrobamail.com/v3/api/campaigns \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "camp_name": "Promo abril",
    "asunto": "Llegó la promo",
    "html": "<h1>Hola</h1>",
    "from_mail": "[email protected]",
    "list_id": ["1A2B3C"]
  }'

# 200 OK  → { "ok": true }
Módulos

11 módulos · 100+ endpoints

Cobertura completa da plataforma. Toque em um módulo para ver sua referência: endpoints, parâmetros, respostas e exemplos em curl, Node, PHP e Python.

Módulo 012 endpoints

Auth

JWT Bearer Token, rate limiting por IP e username, suporte multilíngue (es/en) e rememberMe para sessões de 365 dias.

  • POST /auth/getToken
  • POST /auth/logout
Ver referência do módulo
Módulo 0322 endpoints

Campaigns

Crie, agende e envie campanhas. HTML personalizado, editor visual, templates, tracking de aberturas, clicks, conversões e bounces.

  • POST /campaigns
  • PUT /campaigns/:id/send
  • GET /campaigns/:id/stats
Ver referência do módulo
Módulo 0424 endpoints

Lists & Contacts

Listas, importação CSV/Excel, custom fields, duplo opt-in, ferramentas de limpeza, gestão de unsubscribes e bounces.

  • POST /lists
  • POST /lists/:id/contacts
  • DELETE /lists/:id/contacts/:contact
Ver referência do módulo
Módulo 0513 endpoints

Segmentations

Segmentação V2 com grupos de condições avançados, segmentação por comportamento (aberturas, clicks) e por campos custom.

  • POST /segments
  • GET /segments/:id/preview
Ver referência do módulo
Módulo 0621 endpoints

Users & Roles

Papéis Admin / Reseller / Usuário. Gestão de subcontas, hierarquia reseller, endpoint público para signup de demo.

  • POST /users
  • GET /users/:id
  • PUT /users/:id/role
Ver referência do módulo
Módulo 073 endpoints

Senders

Verificação de remetentes, from name, from email e reply_to configuráveis por sender.

  • POST /senders/verify
  • GET /senders
Ver referência do módulo
Módulo 083 endpoints

Templates

Templates reutilizáveis, importação e exportação entre contas.

  • POST /templates
  • GET /templates/:id
Ver referência do módulo
Módulo 094 endpoints

Dashboard

Métricas consolidadas do usuário autenticado: envios, aberturas, clicks e bounces.

  • GET /dashboard
  • GET /dashboard/stats
Ver referência do módulo
Módulo 102 endpoints

Search

Busca transversal em campanhas, listas e contatos.

  • GET /search?q=
Ver referência do módulo
Módulo 123 endpoints

Subscription

Endpoints públicos (sem auth) para autoatendimento de assinantes. Utilizável em formulários incorporados em sites externos.

  • POST /public/subscribe
  • POST /public/unsubscribe
Ver referência do módulo
Módulo 169 endpoints

Automations V2

Fluxos automatizados com nós e arestas. Triggers por eventos, ações encadeáveis e delays configuráveis.

  • POST /automations
  • PUT /automations/:id/activate
Ver referência do módulo

Procurando algo específico? Explore a referência completa com busca de endpoints.

Webhooks bidirecionais

Seu app reage em tempo real

Você configura uma URL do seu app e enviamos POSTs HTTP com eventos à medida que acontecem: uma campanha terminou, um contato abriu, um e-mail deu bounce, alguém se descadastrou, um flow de automation disparou.

  • Eventos para aberturas, clicks, bounces, reclamações, descadastros e automações
  • POSTs HTTP para a URL que você configurar no seu sistema
  • Histórico de eventos para auditar o que aconteceu e quando
  • Útil para CRM, ecommerce, sistemas internos e dashboards próprios

Endpoint receptor

POST https://tudominio.com/webhooks/arrobamail
Eventos disponíveisLive feed
  • campaign.sentPOST
    { "campaign_id": 9821, "sent_at": "2026-05-26T14:32:00Z", "recipients": 8420 }

    Uma campanha terminou o envio.

  • contact.openPOST
    { "campaign_id": 9821, "contact_id": 555012, "opened_at": "..." }

    Um contato abriu um e-mail.

  • contact.bouncePOST
    { "contact_id": 555013, "type": "hard", "reason": "user_not_found" }

    Um e-mail deu bounce.

  • contact.complaintPOST
    { "contact_id": 555014, "campaign_id": 9821 }

    Um destinatário reportou spam.

  • contact.unsubscribePOST
    { "contact_id": 555015, "list_id": 1234 }

    Um contato se descadastrou.

  • automation.triggeredPOST
    { "automation_id": 88, "contact_id": 555016, "node": "welcome" }

    Um contato entrou em um flow de automation.

Clientes HTTP

Integre com a stack que você já usa

A API é REST JSON: você não depende de uma biblioteca proprietária para começar a operar.

Disponível hoje

curl + qualquer cliente HTTP

A API é REST JSON padrão. Qualquer linguagem que consiga fazer HTTP a consome.

Disponível hoje

JavaScript / TypeScript

Use o fetch nativo, Axios ou outro cliente HTTP. Os exemplos mostram headers, payload e resposta.

Disponível hoje

Python

Consuma a API com requests, httpx ou o cliente HTTP que sua stack já usa.

Disponível hoje

PHP

Funciona com cURL, Guzzle ou clientes PSR-18. Você não precisa de uma biblioteca proprietária.

Perguntas frequentes

O que mais se pergunta sobre a API

Com um token JWT. Você solicita o token com POST /auth/getToken (seu usuário e senha) e o envia no header Authorization de cada chamada. Você pode ativar o rememberMe para sessões de até 365 dias. Uma observação: criar contas não faz parte da API pública — os cadastros são gerenciados pelo reseller.

Ver o quickstartMódulo Auth na referência

Sim, aplicamos limites por IP e por usuário. São folgados para um uso normal; se detectarmos abuso, reduzimos a velocidade automaticamente. Se sua integração precisar de uma cota maior, fale com a gente e avaliamos o seu caso.

Falar com a equipe

REST. JSON sobre HTTP, com os verbos de sempre (GET, POST, PUT, DELETE) e códigos de status padrão. Escolhemos REST porque é o mais universal e fácil de consumir a partir de qualquer linguagem.

Ver a referência

Sim. Você configura uma URL na sua conta e a arrobaMail avisa quando algo acontece: uma campanha terminou de ser enviada, alguém abriu, um e-mail deu bounce, alguém reclamou ou se descadastrou, ou um contato entrou em uma automação. É a forma de o seu sistema reagir em tempo real.

Ver os eventosComo integrá-los

Não é necessário. A API é REST/JSON e funciona com curl, fetch, Axios, requests, httpx, Guzzle ou o cliente HTTP que sua stack já usa. O quickstart traz exemplos em curl, Node, PHP e Python prontos para copiar. Se sua equipe precisar de uma biblioteca específica, conte para a gente qual é a sua stack.

Ver exemplos por linguagem

Sim. A arrobaMail tem um servidor MCP para que assistentes como Claude ou Cursor consultem dados, preparem rascunhos e executem ações, sempre dentro das permissões que você definir. É complementar à API: MCP para o dia a dia assistido, a API para integrações sob medida.

Ver o MCPQual caminho escolher

Sim: a conta do Plano Gratuito funciona como sandbox. Você faz tudo o que faria em produção — com envios mensais e gerações de IA incluídos, sem cartão. Para um volume maior de testes antes de ir para produção, fale com a gente.

Criar conta grátis
Ecossistema de integração

Continue explorando o ecossistema

Panorama de integração

Os quatro caminhos para conectar a arrobaMail e qual convém em cada caso.

Abrir

MCP para assistentes de IA

Opere sua conta em linguagem natural pelo Claude, Cursor ou VS Code.

Abrir

Guia em linguagem simples

Quando cada caminho vale a pena, explicado sem termos técnicos.

Abrir

Comece com o arrobaMail
em menos de 5 minutos.

Plano Gratuito, gerações de IA incluídas, sem cartão de crédito e suporte real em português.

Testar grátis agora
WhatsAppA equipe responde