Email

Cancelar email

Cancela un email programado antes de que se despache. Una vez que el email pasa a pending, ya no se puede cancelar.

POSThttps://mail.sendcorex.com/v3.0/:id/cancel
!

Solo se pueden cancelar los emails programados.Usa el id devuelto porProgramar email y cancela antes de que el email pase a pending.

Parámetros de path

  • idstring (UUID)obligatorio

    El ID del email devuelto por el endpoint de programación.

    p. ej. "3f2a1b4c-8e9d-4f7a-b2c3-1a2b3c4d5e6f"

Inicio rápido

import axios from 'axios';

const emailId = '3f2a1b4c-8e9d-4f7a-b2c3-1a2b3c4d5e6f';

const response = await axios.post(
  'https://mail.sendcorex.com/v3.0/' + emailId + '/cancel',
  {},
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } }
);

console.log(response.data.code); // EMAIL_CANCELLED

Respuesta

{
  "success": true,
  "code": "EMAIL_CANCELLED",
  "message": "Scheduled email cancelled successfully",
  "id": "3f2a1b4c-8e9d-4f7a-b2c3-1a2b3c4d5e6f"
}

Los errores devuelven un objeto JSON con error y code.

  • 401MISSING_AUTH_HEADER

    No hay header Authorization.

  • 401INVALID_API_KEY

    La API key no es válida o fue revocada.

  • 401ACCOUNT_BLOCKED

    La cuenta fue bloqueada.

  • 401NO_CREDITS_LEFT

    No hay créditos de email suficientes para todos los destinatarios. Cada dirección en to, cc y bcc usa 1 crédito.

  • 401USER_NOT_FOUND

    Usuario no encontrado.

  • 401MISSING_USER_PRIVILEGES

    Faltan privilegios de usuario.

  • 401EMAIL_CREDITS_NOT_FOUND

    Error al obtener los créditos de email.

  • 401EMAIL_NOT_VALIDATED

    El email de la cuenta aún no fue verificado.

  • 429CREDENTIAL_TEMPORARILY_BLOCKED

    API key bloqueada temporalmente por violaciones repetidas de la política.

  • 429IP_TEMPORARILY_BLOCKED

    IP de la solicitud bloqueada temporalmente por violaciones repetidas de la política.

  • 429TOO_MANY_CONCURRENT_CONNECTIONS

    Demasiadas solicitudes simultáneas desde esta IP. Inténtalo de nuevo en breve.

  • 500INTERNAL_SERVER_ERROR

    Error inesperado del servidor. Inténtalo de nuevo.

  • 503AUTH_UNAVAILABLE

    No se pudo validar la API key en este momento. Inténtalo de nuevo.