Publiq

Quickstart: enviar seu primeiro e-mail

Um passo a passo completo para enviar seu primeiro e-mail com o Publiq, entender a resposta e evoluir para templates e rastreamento.

Este guia assume que você já fez a Instalação e configurou PUBLIQ_API_KEY. Em poucos minutos você envia um e-mail, entende a resposta e passa a usar templates.

Passo 1 — Envie um e-mail

import { Publiq } from 'publiq';

const publiq = new Publiq(process.env.PUBLIQ_API_KEY);

const email = await publiq.emails.send({
  from: 'you@yourdomain.com',
  to: 'user@example.com',
  subject: 'Hello from Publiq',
  html: '<h1>It works!</h1><p>Your first email is on its way.</p>',
});

console.log(email.id); // msg_...
from publiq import Publiq

publiq = Publiq()  # reads PUBLIQ_API_KEY

email = publiq.emails.send({
    "from": "you@yourdomain.com",
    "to": "user@example.com",
    "subject": "Hello from Publiq",
    "html": "<h1>It works!</h1><p>Your first email is on its way.</p>",
})

print(email["id"])  # msg_...
curl -X POST https://api.publiq.digital/v1/emails \
  -H "Authorization: Bearer $PUBLIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "you@yourdomain.com",
    "to": "user@example.com",
    "subject": "Hello from Publiq",
    "html": "<h1>It works!</h1>"
  }'

O from precisa estar em um domínio verificado. Se você ainda não verificou, faça isso primeiro — veja Domínios e verificação.

Passo 2 — Entenda a resposta

O envio é assíncrono: a API aceita e enfileira o e-mail, devolvendo o id e o status inicial queued. O status evolui (sent → delivered → opened…) e você acompanha por Webhooks ou no painel.

{
  "id": "msg_01J9Z...",
  "status": "queued",
  "external_id": null
}

Passo 3 — Use um template

Em vez de HTML inline, crie um template no builder com IA e referencie-o pela templateKey. As variables preenchem os {{ }} no envio:

await publiq.emails.send({
  from: 'you@yourdomain.com',
  to: 'user@example.com',
  templateKey: 'welcome-email',
  variables: { first_name: 'Ana' }, // -> {{ first_name }}
});

Próximos passos

Quickstart: enviar seu primeiro e-mail — Publiq Docs