E-mail

Annuler un e-mail

Annulez un e-mail planifié avant son envoi. Une fois l'e-mail passé en pending, il ne peut plus être annulé.

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

Seuls les e-mails planifiés peuvent être annulés.Utilisez l'id renvoyé parPlanifier un e-mail et annulez avant que l'e-mail ne passe en pending.

Paramètres de chemin

  • idstring (UUID)obligatoire

    L'ID de l'e-mail renvoyé par l'endpoint de planification.

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

Démarrage rapide

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

Réponse

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

Les erreurs renvoient un objet JSON avec error et code.

  • 401MISSING_AUTH_HEADER

    Aucun en-tête Authorization n'est présent.

  • 401INVALID_API_KEY

    La clé API est invalide ou révoquée.

  • 401ACCOUNT_BLOCKED

    Le compte a été bloqué.

  • 401NO_CREDITS_LEFT

    Crédits e-mail insuffisants pour tous les destinataires. Chaque adresse dans to, cc et bcc utilise 1 crédit.

  • 401USER_NOT_FOUND

    Utilisateur introuvable.

  • 401MISSING_USER_PRIVILEGES

    Privilèges utilisateur manquants.

  • 401EMAIL_CREDITS_NOT_FOUND

    Erreur lors de la récupération des crédits e-mail.

  • 401EMAIL_NOT_VALIDATED

    L'adresse e-mail du compte n'a pas encore été vérifiée.

  • 429CREDENTIAL_TEMPORARILY_BLOCKED

    Clé API temporairement bloquée après des violations répétées de la politique.

  • 429IP_TEMPORARILY_BLOCKED

    IP de la requête temporairement bloquée après des violations répétées de la politique.

  • 429TOO_MANY_CONCURRENT_CONNECTIONS

    Trop de requêtes simultanées depuis cette IP. Réessayez dans un instant.

  • 500INTERNAL_SERVER_ERROR

    Erreur serveur inattendue. Réessayez.

  • 503AUTH_UNAVAILABLE

    Impossible de valider la clé API pour le moment. Réessayez.