Listar campanhas
get
https://app.madmail.com.br/api/v1/campaignsRequer autenticação: Authorization: Bearer us_SUA_CHAVE
Parâmetros de consulta
pagestringOpcionalNúmero da página para paginação (padrão: 1)
statusstringOpcionalFiltrar campanhas por status
- Valores:
- "DRAFT" · "SCHEDULED" · "RUNNING" · "PAUSED" · "SENT"
searchstringOpcionalBuscar campanhas por nome ou assunto
Exemplo de requisição
curl -X GET "https://app.madmail.com.br/api/v1/campaigns" \
-H "Authorization: Bearer us_SUA_CHAVE"Resposta
200Obtém a lista de campanhas
campaignsarray<object>ObrigatórioidstringObrigatórionamestringObrigatóriofromstringObrigatóriosubjectstringObrigatóriocreatedAtstringObrigatório- Formato:
- date-time
updatedAtstringObrigatório- Formato:
- date-time
statusstringObrigatórioscheduledAtstring | nullObrigatório- Formato:
- date-time
totalintegerObrigatóriosentintegerObrigatóriodeliveredintegerObrigatóriounsubscribedintegerObrigatóriototalPageintegerObrigató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
}