arrobaMail
REST · JWT · v3

Referência da API arrobaMail

119 endpoints em 12 módulos, com parâmetros, corpos, respostas e exemplos em cURL, JavaScript, PHP e Python.

URL base

https://envios.arrobamail.com/v3/api

Substitua envios pelo servidor atribuído à sua conta no momento do cadastro.

Autenticação

JWT. Obtenha um token com POST /auth/getToken e envie no header Authorization: Bearer <token>.

Formato de resposta

Sempre JSON. Os erros têm o formato { error, code, message }.

Módulos

01Auth2
/auth
  • POST/auth/getToken
  • POST/auth/logout
Ver módulo
03Campaigns25
/campaigns

Admin sem restrição. Reseller vê campanhas de seus subusuários. Usuário vê apenas suas próprias campanhas.

  • GET/campaigns
  • POST/campaigns
  • POST/campaigns/test
Ver módulo
04Lists26
/lists

Gestão completa de listas, campos personalizados, importação/exportação e ferramentas de limpeza.

  • GET/lists
  • GET/lists/dashboard
  • POST/lists
Ver módulo
05Segmentations13
/segmentations

Disponível na versão legada e V2 (grupos de condições).

  • GET/segmentations/conditions
  • GET/segmentations
  • GET/segmentations/:id
Ver módulo
06Users27
/users

Endpoints marcados como Reseller exigem papel de reseller ou superior.

  • GET/users/me
  • PUT/users/me
  • PUT/users/me/password
Ver módulo
07Senders3
/senders
  • GET/senders
  • POST/senders
  • GET/senders/:encid
Ver módulo
08Templates3
/templates
  • GET/templates
  • GET/templates/:templateId
  • DELETE/templates/:templateId
Ver módulo
09Dashboard4
/dashboard

Estatísticas e métricas do usuário autenticado.

  • GET/dashboard/subscribersLog
  • GET/dashboard/hoursActivity
  • GET/dashboard/campStats
Ver módulo
10Search2
/search
  • GET/search/users
  • GET/search/subscribers
Ver módulo
12Subscription3
/subscription

Sem autenticação. Endpoints públicos para autoatendimento de assinantes.

  • GET/subscription/:xsid
  • PUT/subscription/:xsid
  • DELETE/subscription/:xsid
Ver módulo
16Automations9
/automations

Fluxos de automação V2 com nós e arestas.

  • GET/automations
  • GET/automations/:id
  • POST/automations
Ver módulo
18Observability2
/observability

Métricas e health scores de subusuários.

  • GET/observability/users
  • GET/observability/users/:id
Ver módulo

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