Criar campanha
Cria uma campanha de e-mail no workspace.
https://external-api.lip7.com.br/api/external/email/campaignsemail:campaigns:writeSíncrono — responde 200 com os dadosOperação síncrona — responde 201 com a campanha criada. A campanha nasce em DRAFT, a menos que scheduledFor seja informado.
namestringobrigatórioNome interno da campanha.
subjectstringobrigatórioAssunto do e-mail.
fromNamestringobrigatórioNome de exibição do remetente.
fromEmailstringobrigatórioE-mail remetente verificado.
replyTostringopcionalE-mail para respostas.
templateIdstringopcionalID do template de e-mail a usar.
htmlContentstringopcionalCorpo HTML, quando não usa template.
textContentstringopcionalVersão em texto puro.
segmentIdstringopcionalID de um segmento de contatos.
segmentRulesarrayopcionalRegras de segmentação.
recipientFilterarrayopcionalFiltros de destinatários.
scheduledForstringopcionalData e hora no formato ISO 8601. Se informado, a campanha já nasce agendada.
sendStrategystringopcionalEstratégia de disparo.
THROTTLEDALL_AT_ONCEattachmentsarrayopcionalAnexos enviados a todos os destinatários da campanha, com o mesmo formato do envio transacional — veja Anexos. Ficam guardados com a campanha e são reenviados em cada disparo.
Campanha com anexo envia mais devagar
Quando a campanha tem anexo, o disparo passa a ser feito e-mail a e-mail em vez de em lote — veja Anexos.
{
"name": "Promo Junho",
"subject": "Ofertas especiais",
"fromName": "Sua Empresa",
"fromEmail": "marketing@suaempresa.com",
"templateId": "tpl_email_123",
"segmentId": "seg_ativos",
"sendStrategy": "THROTTLED"
}{
"name": "Catálogo 2026",
"subject": "Nosso novo catálogo",
"fromName": "Sua Empresa",
"fromEmail": "marketing@suaempresa.com",
"htmlContent": "<p>Confira o catálogo em anexo.</p>",
"segmentId": "seg_ativos",
"attachments": [
{ "filename": "catalogo-2026.pdf", "url": "https://cdn.suaempresa.com/catalogo.pdf" }
]
}{
"success": true,
"data": {
"id": "camp_...",
"name": "Promo Junho",
"status": "DRAFT"
}
}{
"success": false,
"error": "INVALID_EMAIL_ATTACHMENT"
}