Módulo 169 endpoints

Automations `/automations`

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

Endpoints

9 no total

GET/automationsUsuário

Listar fluxos de automação

Query params

Nome	Tipo	Obrig.	Default	Descrição
`status`	`string`	Não	`-`	draft, active, paused, archived
`page`	`number`	Não	`1`	Página
`limit`	`number`	Não	`50`	Itens por página

Exemplo

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

Resposta 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/:idUsuário

Detalhe com nós, arestas e configuração

Parâmetros de rota

Nome	Descrição
`id`	ID numérico do fluxo de automação

Exemplo

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

POST/automationsUsuário

Criar fluxo de automação

Trigger types válidos: subscribe, unsubscribe, open, click, event, anniversary, site_track, tag_added, tag_removed, field_changed. Node types válidos: trigger, action, delay, condition, ab_split, exit.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`name`	`string`	Sim	Nome do fluxo (máx. 200 caracteres)
`triggerType`	`string`	Sim	subscribe \| unsubscribe \| open \| click \| event \| anniversary \| site_track \| tag_added \| tag_removed \| field_changed
`triggerConfig`	`object`	Não	Configuração do trigger
`validFrom`	`string`	Não	Data de início de validade
`validTo`	`string`	Não	Data de fim de validade
`reentry`	`string`	Não	never \| always \| after_completion \| cooldown
`nodes`	`array`	Não	Array de nós do fluxo
`edges`	`array`	Não	Array de arestas entre nós

Exemplo

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/:idUsuário

Atualizar fluxo

Não é possível alterar o triggerType enquanto o fluxo estiver ativo.

Parâmetros de rota

Nome	Descrição
`id`	ID do fluxo de automação

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`name`	`string`	Não	Novo nome
`nodes`	`array`	Não	Array de nós
`edges`	`array`	Não	Array de arestas

Exemplo

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

Resposta 200

{ "success": true }

DELETE/automations/:idUsuário

Excluir fluxo (cascata)

Exclui o fluxo e todos os seus dados relacionados (enrollments, logs, nós).

Parâmetros de rota

Nome	Descrição
`id`	ID do fluxo de automação

Exemplo

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

Resposta 200

{ "success": true }

PUT/automations/:id/activateUsuário

Ativar fluxo

O fluxo deve ter pelo menos um nó trigger e um nó action.

Parâmetros de rota

Nome	Descrição
`id`	ID do fluxo de automação

Exemplo

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

Resposta 200

{ "success": true }

PUT/automations/:id/pauseUsuário

Pausar fluxo ativo

Parâmetros de rota

Nome	Descrição
`id`	ID do fluxo de automação

Exemplo

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

Resposta 200

{ "success": true }

GET/automations/:id/statsUsuário

Estatísticas do fluxo

Parâmetros de rota

Nome	Descrição
`id`	ID do fluxo de automação

Exemplo

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

Resposta 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/enrollmentsUsuário

Inscrições do fluxo

Parâmetros de rota

Nome	Descrição
`id`	ID do fluxo de automação

Query params

Nome	Tipo	Obrig.	Default	Descrição
`page`	`number`	Não	`1`	Página
`limit`	`number`	Não	`50`	Itens por página
`status`	`string`	Não	`-`	active, waiting, completed, exited, error

Exemplo

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

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

Automations /automations

Listar fluxos de automação

Detalhe com nós, arestas e configuração

Criar fluxo de automação

Atualizar fluxo

Excluir fluxo (cascata)

Ativar fluxo

Pausar fluxo ativo

Estatísticas do fluxo

Inscrições do fluxo

Comece com o arrobaMailem menos de 5 minutos.

Automations `/automations`

Comece com o arrobaMail
em menos de 5 minutos.