Madmail

Criar campanha

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

Requer autenticação: Authorization: Bearer us_SUA_CHAVE

Corpo da requisição

namestringObrigatório
Tamanho:
mín. 1
fromstringObrigatório
Tamanho:
mín. 1
subjectstringObrigatório
Tamanho:
mín. 1
previewTextstringOpcional
contactBookIdstringObrigatório
Tamanho:
mín. 1
contentstringOpcional
Tamanho:
1–1048576
htmlstringOpcional
Tamanho:
mín. 1
replyTostring | array<string>Opcional
ccstring | array<string>Opcional
bccstring | array<string>Opcional
sendNowbooleanOpcional
scheduledAtstringOpcional

Data e hora no formato ISO 8601 ou em linguagem natural em inglês (ex.: 'tomorrow 9am', 'next monday 10:30')

batchSizeintegerOpcional

Exemplo de requisição

curl -X POST "https://app.madmail.com.br/api/v1/campaigns" \
  -H "Authorization: Bearer us_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Exemplo",
    "from": "cliente@exemplo.com",
    "subject": "Assunto do e-mail",
    "contactBookId": "abc123"
  }'

Resposta

200

Cria uma campanha

idstringObrigatório
namestringObrigatório
fromstringObrigatório
subjectstringObrigatório
previewTextstring | nullObrigatório
contactBookIdstring | nullObrigatório
htmlstring | nullObrigatório
contentstring | nullObrigatório
statusstringObrigatório
scheduledAtstring | nullObrigatório
Formato:
date-time
batchSizeintegerObrigatório
batchWindowMinutesintegerObrigatório
totalintegerObrigatório
sentintegerObrigatório
deliveredintegerObrigatório
openedintegerObrigatório
clickedintegerObrigatório
unsubscribedintegerObrigatório
bouncedintegerObrigatório
hardBouncedintegerObrigatório
complainedintegerObrigatório
replyToarray<string>Obrigatório
ccarray<string>Obrigatório
bccarray<string>Obrigatório
createdAtstringObrigatório
Formato:
date-time
updatedAtstringObrigatório
Formato:
date-time
{
  "id": "abc123",
  "name": "Exemplo",
  "from": "cliente@exemplo.com",
  "subject": "Assunto do e-mail",
  "previewText": "string",
  "contactBookId": "abc123",
  "html": "<p>Olá!</p>",
  "content": "string",
  "status": "string",
  "scheduledAt": "2024-01-01T00:00:00Z",
  "batchSize": 1,
  "batchWindowMinutes": 1,
  "total": 1,
  "sent": 1,
  "delivered": 1,
  "opened": 1,
  "clicked": 1,
  "unsubscribed": 1,
  "bounced": 1,
  "hardBounced": 1,
  "complained": 1,
  "replyTo": [
    "string"
  ],
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}