Listar campanhas

gethttps://app.madmail.com.br/api/v1/campaigns

Requer autenticação: Authorization: Bearer us_SUA_CHAVE

Parâmetros de consulta

pagestringOpcional

Número da página para paginação (padrão: 1)

statusstringOpcional

Filtrar campanhas por status

Valores:
"DRAFT" · "SCHEDULED" · "RUNNING" · "PAUSED" · "SENT"

Exemplo de requisição

curl -X GET "https://app.madmail.com.br/api/v1/campaigns" \
  -H "Authorization: Bearer us_SUA_CHAVE"

Resposta

200

Obtém a lista de campanhas

campaignsarray<object>Obrigatório
idstringObrigatório
namestringObrigatório
fromstringObrigatório
subjectstringObrigatório
createdAtstringObrigatório
Formato:
date-time
updatedAtstringObrigatório
Formato:
date-time
statusstringObrigatório
scheduledAtstring | nullObrigatório
Formato:
date-time
totalintegerObrigatório
sentintegerObrigatório
deliveredintegerObrigatório
unsubscribedintegerObrigatório
totalPageintegerObrigatório
{
  "campaigns": [
    {
      "id": "abc123",
      "name": "Exemplo",
      "from": "cliente@exemplo.com",
      "subject": "Assunto do e-mail",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "status": "string",
      "scheduledAt": "2024-01-01T00:00:00Z",
      "total": 1,
      "sent": 1,
      "delivered": 1,
      "unsubscribed": 1
    }
  ],
  "totalPage": 1
}