Saltar al contenido principal
Empezar

Quickstart

De cero al primer email entregado, en cualquier lenguaje.

1. Crea una clave de API

En el panel, en Claves de API, crea una clave con alcance sending_access y guárdala en el entorno. Alcances y autenticación

.env
COFFEEMAIL_API_KEY=cm_live_sua_chave

2. Verifica el dominio del remitente

Agrega el dominio y publica los registros DNS. Mientras tanto, usa el sandbox para probar. Guía de verificación de dominio

3. Instala el SDK

Elige el lenguaje. Todos tienen la misma superficie y el mismo retorno con datos o error.

npm install @coffeemail/node

4. Envía el email

El email entra en la cola y la respuesta vuelve con el id en milisegundos.

import { CoffeeMail } from '@coffeemail/node'; const coffeemail = new CoffeeMail(process.env.COFFEEMAIL_API_KEY); const { data, error } = await coffeemail.emails.send({  from: 'Acme <pedidos@acme.com.br>',  to: 'ana@exemplo.com.br',  subject: 'Seu pedido #4821 foi enviado',  html: '<p>Chega amanhã.</p>',  idempotencyKey: 'pedido-4821-enviado',});
202 Accepted
{  "id": "8f3a2c1b-4d5e-4f60-9a7b-1c2d3e4f5a6b",  "status": "queued",  "queuedAt": "2026-11-10T17:02:11.204Z"}

5. Sigue la entrega

Recibe los eventos (entregado, abierto, rebote) en un webhook firmado o consulta los eventos del email. Guía de webhooks