arrobaMail
Module 169 endpoints

Automations /automations

V2 automation flows with nodes and edges.

Endpoints

9 total
GET/automationsUser

List automation flows

Query params

NameTypeReq.DefaultDescription
statusstringNo-draft, active, paused, archived
pagenumberNo1Page
limitnumberNo50Items per page

Example

curl -X GET "https://envios.arrobamail.com/v3/api/automations" \
  -H "Authorization: Bearer $TOKEN"

Response 200

{
  "flows": [
    {
      "id": 7, "name": "Bienvenida nuevos suscriptores",
      "status": "active", "triggerType": "subscribe",
      "totalEnrolled": 1250, "active": 85,
      "dateCreated": "2025-04-10 08:00:00"
    }
  ],
  "total": 5, "page": 1, "limit": 50
}
GET/automations/:idUser

Detail with nodes, edges, and configuration

Path parameters

NameDescription
idNumeric automation flow ID

Example

curl -X GET "https://envios.arrobamail.com/v3/api/automations/{ID}" \
  -H "Authorization: Bearer $TOKEN"
POST/automationsUser

Create automation flow

Valid trigger types: subscribe, unsubscribe, open, click, event, anniversary, site_track, tag_added, tag_removed, field_changed. Valid node types: trigger, action, delay, condition, ab_split, exit.

Request body · application/json

NameTypeReq.Description
namestringYesFlow name (max 200 chars)
triggerTypestringYessubscribe | unsubscribe | open | click | event | anniversary | site_track | tag_added | tag_removed | field_changed
triggerConfigobjectNoTrigger configuration
validFromstringNoValidity start date
validTostringNoValidity end date
reentrystringNonever | always | after_completion | cooldown
nodesarrayNoArray of flow nodes
edgesarrayNoArray of edges between nodes

Example

curl -X POST "https://envios.arrobamail.com/v3/api/automations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "triggerType": "...",
  "triggerConfig": {},
  "validFrom": "...",
  "validTo": "...",
  "reentry": "...",
  "nodes": [],
  "edges": []
}'
PATCH/automations/:idUser

Update flow

triggerType cannot be changed while the flow is active.

Path parameters

NameDescription
idAutomation flow ID

Request body · application/json

NameTypeReq.Description
namestringNoNew name
nodesarrayNoArray of nodes
edgesarrayNoArray of edges

Example

curl -X PATCH "https://envios.arrobamail.com/v3/api/automations/{ID}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "nodes": [],
  "edges": []
}'

Response 200

{ "success": true }
DELETE/automations/:idUser

Delete flow (cascade)

Deletes the flow and all its related data (enrollments, logs, nodes).

Path parameters

NameDescription
idAutomation flow ID

Example

curl -X DELETE "https://envios.arrobamail.com/v3/api/automations/{ID}" \
  -H "Authorization: Bearer $TOKEN"

Response 200

{ "success": true }
PUT/automations/:id/activateUser

Activate flow

The flow must have at least one trigger node and one action node.

Path parameters

NameDescription
idAutomation flow ID

Example

curl -X PUT "https://envios.arrobamail.com/v3/api/automations/{ID}/activate" \
  -H "Authorization: Bearer $TOKEN"

Response 200

{ "success": true }
PUT/automations/:id/pauseUser

Pause active flow

Path parameters

NameDescription
idAutomation flow ID

Example

curl -X PUT "https://envios.arrobamail.com/v3/api/automations/{ID}/pause" \
  -H "Authorization: Bearer $TOKEN"

Response 200

{ "success": true }
GET/automations/:id/statsUser

Flow statistics

Path parameters

NameDescription
idAutomation flow ID

Example

curl -X GET "https://envios.arrobamail.com/v3/api/automations/{ID}/stats" \
  -H "Authorization: Bearer $TOKEN"

Response 200

{
  "totalEnrolled": 1250,
  "active": 85,
  "completed": 1100,
  "exited": 50,
  "errors": 15,
  "nodeStats": {
    "n1": { "entered": 1250, "completed": 1250 },
    "n2": { "entered": 1250, "completed": 1240, "errors": 10 }
  }
}
GET/automations/:id/enrollmentsUser

Flow enrollments

Path parameters

NameDescription
idAutomation flow ID

Query params

NameTypeReq.DefaultDescription
pagenumberNo1Page
limitnumberNo50Items per page
statusstringNo-active, waiting, completed, exited, error

Example

curl -X GET "https://envios.arrobamail.com/v3/api/automations/{ID}/enrollments" \
  -H "Authorization: Bearer $TOKEN"

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