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é.
https://mail.sendcorex.com/v3.0/:id/cancelSeuls 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)obligatoireL'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_CANCELLEDRéponse
{
"success": true,
"code": "EMAIL_CANCELLED",
"message": "Scheduled email cancelled successfully",
"id": "3f2a1b4c-8e9d-4f7a-b2c3-1a2b3c4d5e6f"
}Erreurs
Tous les codes d'erreur →Les erreurs renvoient un objet JSON avec error et code.
- 401
MISSING_AUTH_HEADERAucun en-tête Authorization n'est présent.
- 401
INVALID_API_KEYLa clé API est invalide ou révoquée.
- 401
ACCOUNT_BLOCKEDLe compte a été bloqué.
- 401
NO_CREDITS_LEFTCrédits e-mail insuffisants pour tous les destinataires. Chaque adresse dans to, cc et bcc utilise 1 crédit.
- 401
USER_NOT_FOUNDUtilisateur introuvable.
- 401
MISSING_USER_PRIVILEGESPrivilèges utilisateur manquants.
- 401
EMAIL_CREDITS_NOT_FOUNDErreur lors de la récupération des crédits e-mail.
- 401
EMAIL_NOT_VALIDATEDL'adresse e-mail du compte n'a pas encore été vérifiée.
- 429
CREDENTIAL_TEMPORARILY_BLOCKEDClé API temporairement bloquée après des violations répétées de la politique.
- 429
IP_TEMPORARILY_BLOCKEDIP de la requête temporairement bloquée après des violations répétées de la politique.
- 429
TOO_MANY_CONCURRENT_CONNECTIONSTrop de requêtes simultanées depuis cette IP. Réessayez dans un instant.
- 500
INTERNAL_SERVER_ERRORErreur serveur inattendue. Réessayez.
- 503
AUTH_UNAVAILABLEImpossible de valider la clé API pour le moment. Réessayez.