arrobaMail
Try for free
REST · JWT · v3

arrobaMail API reference

119 endpoints across 12 modules, with parameters, bodies, responses, and examples in cURL, JavaScript, PHP, and Python.

Base URL

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

Replace envios with the server assigned to your account when you signed up.

Authentication

JWT. Get a token with POST /auth/getToken and send it in the Authorization: Bearer <token> header.

Response format

Always JSON. Errors follow the shape { error, code, message }.

Modules

01Auth2
/auth
  • POST/auth/getToken
  • POST/auth/logout
View module
03Campaigns25
/campaigns

Admin: no restriction. Reseller sees campaigns from its sub-users. User: only their own campaigns.

  • GET/campaigns
  • POST/campaigns
  • POST/campaigns/test
View module
04Lists26
/lists

Full management of lists, custom fields, import/export, and cleanup tools.

  • GET/lists
  • GET/lists/dashboard
  • POST/lists
View module
05Segmentations13
/segmentations

Available in legacy and V2 versions (condition groups).

  • GET/segmentations/conditions
  • GET/segmentations
  • GET/segmentations/:id
View module
06Users27
/users

Endpoints marked as Reseller require a reseller role or higher.

  • GET/users/me
  • PUT/users/me
  • PUT/users/me/password
View module
07Senders3
/senders
  • GET/senders
  • POST/senders
  • GET/senders/:encid
View module
08Templates3
/templates
  • GET/templates
  • GET/templates/:templateId
  • DELETE/templates/:templateId
View module
09Dashboard4
/dashboard

Statistics and metrics for the authenticated user.

  • GET/dashboard/subscribersLog
  • GET/dashboard/hoursActivity
  • GET/dashboard/campStats
View module
10Search2
/search
  • GET/search/users
  • GET/search/subscribers
View module
12Subscription3
/subscription

No authentication. Public endpoints for subscriber self-service.

  • GET/subscription/:xsid
  • PUT/subscription/:xsid
  • DELETE/subscription/:xsid
View module
16Automations9
/automations

V2 automation flows with nodes and edges.

  • GET/automations
  • GET/automations/:id
  • POST/automations
View module
18Observability2
/observability

Metrics and health scores for sub-users.

  • GET/observability/users
  • GET/observability/users/:id
View module

Get started with arrobaMail
in under 5 minutes.

Free plan, AI generations included, no credit card required — and real support from a real team.

Try it free now
WhatsAppOur team replies