Publiq

Supresiones

Correos bloqueados para envío (bounces, bajas) (`publiq.suppressions`).

El recurso suppressions mantiene la lista de direcciones que nunca deben recibir correo: añadir una manualmente (ej.: solicitud de RGPD), listar las supresiones de la organización y eliminar una dirección en la que vuelves a confiar.

Referencia de métodos

suppressions.create

suppressions.create(params) → Promise<Suppression>

Añade una dirección a la lista de supresiones de la organización, bloqueando futuros envíos a ella.

Parámetros
ParámetroTipoDescripción
emailObligatoriostringDirección a suprimir.
reasonOpcionalstringUno de manual, bounce, complaint, unsubscribe (por defecto manual).

Devuelve: La supresión creada — { object: "suppression", email, reason, ... }.

const suppression = await publiq.suppressions.create({
email: 'ana@example.com',
reason: 'manual',
});
console.log(suppression.email, suppression.reason);
Una dirección suprimida nunca recibe correo: Publiq filtra por destinatario en el momento del envío, así que un cc/bcc suprimido se descarta silenciosamente y, si todos los to están suprimidos, el envío se marca como fallido. Ver Entregabilidad.
Los bounces y las denuncias suelen añadirse automáticamente por Publiq — usa create para supresiones manuales (ej.: solicitud de RGPD) y delete para volver a confiar en una dirección.

suppressions.list

suppressions.list({ limit?, after? }) → Promise<SuppressionList>

Lista las supresiones de la organización, paginado por cursor.

Parámetros
ParámetroTipoDescripción
limitOpcionalnumberÍtems por página (por defecto 20, máx. 100).
afterOpcionalstringCursor: id del último ítem de la página anterior.

Devuelve: Envoltura de lista { object: "list", data: Suppression[] }. Usa el id del último ítem como after en la próxima llamada.

const { data } = await publiq.suppressions.list({ limit: 50 });
// next page:
const next = await publiq.suppressions.list({ after: data[data.length - 1].id });
El listado se pagina por cursor: itera pasando el id del último ítem en after hasta que data venga vacío. Ver Errores & paginación.

suppressions.delete

suppressions.delete(email) → Promise<void>

Elimina una dirección de la lista de supresiones, permitiendo que vuelva a recibir correos.

Parámetros
ParámetroTipoDescripción
emailObligatoriostringDirección suprimida a eliminar.

Devuelve: Sin contenido (204).

await publiq.suppressions.delete('ana@example.com');
El SDK hace el url-encode del correo al construir la ruta DELETE /suppressions/{email} — no necesitas escaparlo tú mismo.

Los ejemplos muestran Node, Python y PHP. En Python los métodos son snake_case (ej.: cancel_run, from_spec) y reciben un dict; en PHP son camelCase y reciben un array asociativo. Las claves del cuerpo siempre son camelCase (templateKey, firstName, scheduledAt) — las respuestas de la API vienen en snake_case.