Módulo 0325 endpoints

Campaigns `/campaigns`

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

Endpoints

25 no total

GET/campaignsUsuário

Listar campanhas com paginação

Query params

Nome	Tipo	Obrig.	Default	Descrição
`limit`	`number`	Não	`25`	Itens por página
`offset`	`number`	Não	`0`	Deslocamento
`status`	`string`	Não	`-`	active, completed, draft, paused, stopped
`q`	`string`	Não	`-`	Busca por nome ou assunto

Exemplo

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

Resposta 200

{
  "paging": { "total": 150, "limit": 25, "offset": 0, "pages": 6 },
  "list": [
    {
      "id": 12345,
      "encid": "1A2B3C",
      "camp_name": "Newsletter Mayo",
      "asunto": "Novedades de Mayo 2025",
      "status": 3,
      "from_name": "Empresa ABC",
      "from_mail": "info@Empresa ABC.com",
      "dateCreated": "2025-05-01 10:30:00",
      "suscribers": 5000,
      "sents": 4850,
      "stats": { "opens": 1200, "clicks": 340, "bounces": 45, "unsubscribes": 12 }
    }
  ]
}

POST/campaignsUsuário

Criar e enfileirar campanha para envio

from_mail deve ser um remetente verificado. Verifica a cota de envio. Detecta duplicados (mesmas listas + assunto em 24h). Anti-spam em from_name.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`camp_name`	`string`	Sim	Nome interno da campanha
`asunto`	`string`	Sim	Assunto do email
`html`	`string`	Sim	Conteúdo HTML
`from_name`	`string`	Sim	Nome do remetente
`from_mail`	`string`	Sim	Email do remetente verificado
`list_id`	`string[]`	Sim	Array de IDs codificados de listas
`preheader`	`string`	Não	Texto de pré-visualização
`texto`	`string`	Não	Versão em texto simples
`reply_to`	`string`	Não	Email para respostas
`seid`	`number`	Não	ID de segmentação
`track_links`	`number`	Não	1 = habilitar rastreamento de links
`track_reads`	`number`	Não	1 = habilitar rastreamento de aberturas
`track_conv`	`number`	Não	1 = habilitar rastreamento de conversões
`g_analytics`	`object`	Não	Configuração do Google Analytics
`draftId`	`number`	Não	ID do rascunho a converter

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/campaigns" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "camp_name": "...",
  "asunto": "...",
  "html": "...",
  "from_name": "...",
  "from_mail": "...",
  "list_id": ["..."],
  "preheader": "...",
  "texto": "...",
  "reply_to": "...",
  "seid": 0,
  "track_links": 0,
  "track_reads": 0,
  "track_conv": 0,
  "g_analytics": {},
  "draftId": 0
}'

Resposta 201

{
  "success": 1,
  "mid": 12345,
  "subscribers": 5000
}

Erros

Status	Code	Descrição
400	`invalid_sender`	Remetente não verificado
400	`subject_required`	Assunto obrigatório
400	`html_required`	HTML obrigatório
400	`lists_required`	Pelo menos uma lista obrigatória
400	`duplicate_campaign`	Campanha duplicada nas últimas 24h
400	`quota_exceeded`	Cota de envios excedida
400	`spamlike_sender_name`	Nome de remetente parecido com spam

POST/campaigns/testUsuário

Enviar email de teste

Hash de conteúdo evita duplicados em 10 minutos.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`email`	`string`	Sim	Email de destino do teste
`subject`	`string`	Sim	Assunto
`html`	`string`	Sim	Conteúdo HTML
`from_name`	`string`	Não	Nome do remetente
`from_mail`	`string`	Não	Email do remetente

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/campaigns/test" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "...",
  "subject": "...",
  "html": "...",
  "from_name": "...",
  "from_mail": "..."
}'

Resposta 200

{ "success": true }

GET/campaigns/:encidUsuário

Detalhe completo da campanha

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha (formato "1A2B3C" ou numérico)

Exemplo

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

Resposta 200

{
  "id": 12345,
  "encid": "1A2B3C",
  "camp_name": "Newsletter de Maio",
  "asunto": "Novidades de maio de 2025",
  "preheader": "Descubra as novidades",
  "status": 3,
  "from_name": "Empresa ABC",
  "from_mail": "[email protected]",
  "reply_to": "[email protected]",
  "track_links": 1,
  "track_reads": 1,
  "dateCreated": "2025-05-01 10:30:00",
  "dateStart": "2025-05-01 10:35:00",
  "dateEnd": "2025-05-01 11:45:00",
  "suscribers": 5000,
  "sents": 4850,
  "stats": {
    "opens": 1200, "unique_opens": 980,
    "clicks": 340, "unique_clicks": 210,
    "bounces": 45, "hard_bounces": 12,
    "unsubscribes": 12, "complaints": 2
  }
}

GET/campaigns/:encid/bodyUsuário

Conteúdo HTML/texto da campanha

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Query params

Nome	Tipo	Obrig.	Default	Descrição
`imagesFullPath`	`boolean`	Não	`false`	Converter caminhos relativos em URLs absolutas

Exemplo

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

Resposta 200

{
  "id": 12345,
  "html": "<html>...</html>",
  "texto": "Versão em texto simples...",
  "asunto": "Novidades de maio de 2025",
  "camp_name": "Newsletter de Maio"
}

GET/campaigns/:encid/stats/subscribersLogsUsuário

Exportar logs de assinantes (Excel)

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

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

Resposta 200

{
  "fileName": "CampaignSubscribersLog-12345.xlsx",
  "date": "2025-05-03 15:30:00"
}

GET/campaigns/:encid/stats/subscriber-actionsUsuário

Ações de assinantes paginadas

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Query params

Nome	Tipo	Obrig.	Default	Descrição
`page`	`int`	Não	`1`	Página
`limit`	`int`	Não	`50`	Itens por página (25, 50, 100)
`action`	`string`	Não	`-`	open, click, bounce, complaint, unsubscribe, subscribe, blocked
`email`	`string`	Não	`-`	Busca parcial de email
`dateFrom`	`int`	Não	`-`	Timestamp Unix
`dateTo`	`int`	Não	`-`	Timestamp Unix
`bounceType`	`string`	Não	`-`	hard, soft, spam, invalid, preblocked
`sort`	`string`	Não	`date_desc`	date_desc, date_asc, email_asc, email_desc

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}/stats/subscriber-actions" \
  -H "Authorization: Bearer $TOKEN"

GET/campaigns/:encid/stats/opens-subscribersUsuário

Assinantes com aberturas paginados

Lista assinantes que abriram uma campanha não arquivada, com primeira abertura e quantidade de leituras.

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Query params

Nome	Tipo	Obrig.	Default	Descrição
`page`	`int`	Não	`1`	Página
`limit`	`int`	Não	`50`	Itens por página (25, 50, 100)
`email`	`string`	Não	`-`	Busca parcial de email
`listId`	`int`	Não	`-`	Filtrar por lista
`sort`	`string`	Não	`reads_desc`	reads_desc, reads_asc, first_open_desc, first_open_asc, email_asc, email_desc

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}/stats/opens-subscribers" \
  -H "Authorization: Bearer $TOKEN"

GET/campaigns/:encid/stats/opens-subscribers/exportUsuário

Exportar lista detalhada de aberturas

Gera um Excel com todos os assinantes que abriram uma campanha não arquivada. Inclui email, lista, aberturas totais e primeira abertura. O arquivo fica em cache por 10 minutos por campanha.

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}/stats/opens-subscribers/export" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{ "fileName": "CampaignOpenSubscribers-12345.xlsx", "date": "2026-05-27T14:00:00.000Z", "exported": 116 }

Erros

Status	Code	Descrição
400	`campaign_archived`	A campanha está arquivada e o detalhe não está mais disponível.

GET/campaigns/:encid/stats/click-qualityUsuário

Qualidade de cliques de links

Separa cliques brutos, provavelmente humanos, provavelmente bot e não classificados, por campanha e por link.

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}/stats/click-quality" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{
  "campaign_id": 12345,
  "quality": {
    "raw_unique_clickers": 120,
    "trusted_unique_clickers": 96,
    "bot_likely_unique": 18,
    "unknown_unique": 6
  },
  "links": []
}

GET/campaigns/:encid/stats/subscriber-actions/urlsUsuário

URLs únicas de cliques

Retorna as URLs rastreadas únicas na campanha com suas contagens de cliques.

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}/stats/subscriber-actions/urls" \
  -H "Authorization: Bearer $TOKEN"

GET/campaigns/:encid/linksUsuário

Links rastreados da campanha

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

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

Resposta 200

{
  "links": [
    { "id": 11, "url": "https://Empresa ABC.com/promo", "indice": 1 },
    { "id": 12, "url": "https://Empresa ABC.com/blog", "indice": 2 }
  ]
}

PATCH/campaigns/:encidUsuário

Atualizar campos da campanha

Somente os campos enviados são modificados. Campos editáveis: camp_name, asunto, preheader, html, texto, from_name, from_mail, reply_to, track_links, track_reads.

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`camp_name`	`string`	Não	Nome interno
`asunto`	`string`	Não	Assunto do email
`preheader`	`string`	Não	Texto de pré-visualização
`html`	`string`	Não	Conteúdo HTML
`from_name`	`string`	Não	Nome do remetente
`from_mail`	`string`	Não	Email do remetente
`track_links`	`number`	Não	0 ou 1
`track_reads`	`number`	Não	0 ou 1

Exemplo

curl -X PATCH "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "camp_name": "...",
  "asunto": "...",
  "preheader": "...",
  "html": "...",
  "from_name": "...",
  "from_mail": "...",
  "track_links": 0,
  "track_reads": 0
}'

Resposta 200

{ "success": true }

DELETE/campaigns/:encidUsuário

Excluir campanha

Superadmin: exclusão física. Outros perfis: soft delete (active=6).

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

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

Resposta 200

{ "success": true }

PUT/campaigns/:encid/status/resumeUsuário

Retomar campanha pausada

A campanha deve ter status 4 (pausada).

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}/status/resume" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{ "success": true }

Erros

Status	Code	Descrição
400	`status_not_paused`	A campanha não está pausada

PUT/campaigns/:encid/status/stopUsuário

Pausar campanha ativa

A campanha deve ter status 0, 1 ou 3.

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}/status/stop" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{ "success": true }

Erros

Status	Code	Descrição
400	`status_not_active`	A campanha não está ativa

PUT/campaigns/:encid/status/approveReseller

Aprovar campanha pendente

A campanha deve ter on_hold=1. O usuário que aprova deve ser o pai/reseller do dono.

Parâmetros de rota

Nome	Descrição
`encid`	ID codificado da campanha

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/campaigns/{ENCID}/status/approve" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{ "success": true }

POST/campaigns/countRecipientsUsuário

Contar destinatários de listas/segmentação

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`lids`	`string[]`	Sim	IDs codificados de listas
`seid`	`number`	Não	ID de segmentação
`active_subs_only`	`boolean`	Não	Somente assinantes ativos

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/campaigns/countRecipients" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "lids": ["..."],
  "seid": 0,
  "active_subs_only": true
}'

Resposta 200

{ "destinatarios": 5000 }

POST/campaigns/importFromUrlUsuário

Importar HTML a partir de URL

URL válida e acessível. Scripts removidos do HTML importado.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`url`	`string`	Sim	URL HTTP/HTTPS acessível

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/campaigns/importFromUrl" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "..."
}'

Resposta 200

{ "html": "<html>...</html>" }

Erros

Status	Code	Descrição
400	`invalid_url`	Formato de URL inválido
400	`cant_access_url`	Não foi possível acessar a URL

GET/campaigns/draft/:idUsuário

Obter rascunho

O rascunho deve pertencer ao usuário autenticado.

Parâmetros de rota

Nome	Descrição
`id`	ID numérico do rascunho

Exemplo

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

Resposta 200

{
  "id": 456,
  "camp_data": {
    "name": "Borrador Newsletter Mayo",
    "from_mail": "info@Empresa ABC.com",
    "from_name": "Empresa ABC",
    "subject": "Novedades de Mayo 2025",
    "html": "<html>...</html>",
    "list_id": [1, 3],
    "templateId": 10
  },
  "dateCreated": "2025-05-02 14:22:00",
  "dateModified": "2025-05-03 09:15:00"
}

POST/campaigns/draftUsuário

Salvar rascunho

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`camp_data.name`	`string`	Sim	Nome do rascunho
`camp_data.from_mail`	`string`	Não	Email do remetente
`camp_data.from_name`	`string`	Não	Nome do remetente
`camp_data.subject`	`string`	Não	Assunto
`camp_data.html`	`string`	Não	HTML
`camp_data.list_id`	`number[]`	Não	IDs de listas
`camp_data.templateId`	`number`	Não	ID de template

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/campaigns/draft" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "camp_data.name": "...",
  "camp_data.from_mail": "...",
  "camp_data.from_name": "...",
  "camp_data.subject": "...",
  "camp_data.html": "...",
  "camp_data.list_id": [0],
  "camp_data.templateId": 0
}'

Resposta 201

{ "id": 456 }

PUT/campaigns/draft/:idUsuário

Atualizar rascunho

Mesmos campos que POST /campaigns/draft. Merge parcial.

Parâmetros de rota

Nome	Descrição
`id`	ID numérico do rascunho

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`camp_data`	`object`	Sim	Campos a atualizar (merge parcial)

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/campaigns/draft/{ID}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "camp_data": {}
}'

Resposta 200

{ "success": true }

POST/campaigns/spamlikeCheckUsuário

Verificar similaridade com spam

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`subject`	`string`	Sim	Assunto a avaliar
`body`	`string`	Sim	Conteúdo HTML a avaliar

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/campaigns/spamlikeCheck" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "...",
  "body": "..."
}'

Resposta 200

{
  "score": 3.5,
  "threshold": 5.0,
  "isSpam": false,
  "details": { "subject_score": 1.2, "body_score": 2.3 }
}

POST/campaigns/generateUsuário

Gerar conteúdo com IA

Sujeito a limites diários e mensais. Rate limit: 2/min, 10/hora.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`type`	`string`	Sim	"campaignContent" ou "subjectandpreheader"
`prompt`	`string`	Não	Prompt para o tipo campaignContent
`body_html`	`string`	Não	HTML existente para o tipo subjectandpreheader
`images`	`string[]`	Não	URLs de imagens de referência
`useBrandKit`	`boolean`	Não	Default true. Se for false, não usa o Kit de marca ativo

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/campaigns/generate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "...",
  "prompt": "...",
  "body_html": "...",
  "images": ["..."],
  "useBrandKit": true
}'

Erros

Status	Code	Descrição
429	`daily_limit_reached`	Limite diário atingido
429	`monthly_limit_reached`	Limite mensal atingido
429	`per_minute_limit_exceeded`	Muitas requisições por minuto
503	`ai_unavailable`	Serviço de IA indisponível

PUT/campaigns/generationLogs/:generationId/feedbackUsuário

Enviar feedback sobre geração de IA

Parâmetros de rota

Nome	Descrição
`generationId`	ID do log de geração de IA

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`rating`	`integer`	Não	Pontuação de 1 a 5
`userComments`	`string`	Não	Comentários do usuário

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/campaigns/generationLogs/{GENERATIONID}/feedback" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "rating": 0,
  "userComments": "..."
}'

Resposta 200

{ "success": true }

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

Campaigns /campaigns

Listar campanhas com paginação

Criar e enfileirar campanha para envio

Enviar email de teste

Detalhe completo da campanha

Conteúdo HTML/texto da campanha

Exportar logs de assinantes (Excel)

Ações de assinantes paginadas

Assinantes com aberturas paginados

Exportar lista detalhada de aberturas

Qualidade de cliques de links

URLs únicas de cliques

Links rastreados da campanha

Atualizar campos da campanha

Excluir campanha

Retomar campanha pausada

Pausar campanha ativa

Aprovar campanha pendente

Contar destinatários de listas/segmentação

Importar HTML a partir de URL

Obter rascunho

Salvar rascunho

Atualizar rascunho

Verificar similaridade com spam

Gerar conteúdo com IA

Enviar feedback sobre geração de IA

Comece com o arrobaMailem menos de 5 minutos.

Campaigns `/campaigns`

Comece com o arrobaMail
em menos de 5 minutos.