Email

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.

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

Só 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ório

    O 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_CANCELLED

Resposta

{
  "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.

  • 401MISSING_AUTH_HEADER

    Nenhum header Authorization presente.

  • 401INVALID_API_KEY

    A API key é inválida ou foi revogada.

  • 401ACCOUNT_BLOCKED

    A conta foi bloqueada.

  • 401NO_CREDITS_LEFT

    Créditos de email insuficientes para todos os destinatários. Cada endereço em to, cc e bcc usa 1 crédito.

  • 401USER_NOT_FOUND

    Usuário não encontrado.

  • 401MISSING_USER_PRIVILEGES

    Faltam privilégios de usuário.

  • 401EMAIL_CREDITS_NOT_FOUND

    Erro ao buscar os créditos de email.

  • 401EMAIL_NOT_VALIDATED

    O email da conta ainda não foi verificado.

  • 429CREDENTIAL_TEMPORARILY_BLOCKED

    API key bloqueada temporariamente por violações repetidas da política.

  • 429IP_TEMPORARILY_BLOCKED

    IP da requisição bloqueado temporariamente por violações repetidas da política.

  • 429TOO_MANY_CONCURRENT_CONNECTIONS

    Requisições simultâneas demais deste IP. Tente de novo em instantes.

  • 500INTERNAL_SERVER_ERROR

    Erro inesperado no servidor. Tente de novo.

  • 503AUTH_UNAVAILABLE

    Não foi possível validar a API key agora. Tente de novo.