Cancelar email
Cancele um email agendado antes de ele ser despachado. Depois que o email passa para pending, ele não pode mais ser cancelado.
https://mail.sendcorex.com/v3.0/:id/cancelSó emails agendados podem ser cancelados.Use o id retornado porAgendar email e cancele antes que o email passe para pending.
Parâmetros de path
idstring (UUID)obrigatórioO ID do email retornado pelo endpoint de agendamento.
ex.
"3f2a1b4c-8e9d-4f7a-b2c3-1a2b3c4d5e6f"
Início 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_CANCELLEDResposta
{
"success": true,
"code": "EMAIL_CANCELLED",
"message": "Scheduled email cancelled successfully",
"id": "3f2a1b4c-8e9d-4f7a-b2c3-1a2b3c4d5e6f"
}Os erros retornam um objeto JSON com error e code.
- 401
MISSING_AUTH_HEADERNenhum header Authorization presente.
- 401
INVALID_API_KEYA API key é inválida ou foi revogada.
- 401
ACCOUNT_BLOCKEDA conta foi bloqueada.
- 401
NO_CREDITS_LEFTCréditos de email insuficientes para todos os destinatários. Cada endereço em to, cc e bcc usa 1 crédito.
- 401
USER_NOT_FOUNDUsuário não encontrado.
- 401
MISSING_USER_PRIVILEGESFaltam privilégios de usuário.
- 401
EMAIL_CREDITS_NOT_FOUNDErro ao buscar os créditos de email.
- 401
EMAIL_NOT_VALIDATEDO email da conta ainda não foi verificado.
- 429
CREDENTIAL_TEMPORARILY_BLOCKEDAPI key bloqueada temporariamente por violações repetidas da política.
- 429
IP_TEMPORARILY_BLOCKEDIP da requisição bloqueado temporariamente por violações repetidas da política.
- 429
TOO_MANY_CONCURRENT_CONNECTIONSRequisições simultâneas demais deste IP. Tente de novo em instantes.
- 500
INTERNAL_SERVER_ERRORErro inesperado no servidor. Tente de novo.
- 503
AUTH_UNAVAILABLENão foi possível validar a API key agora. Tente de novo.