Recibir correos: Newsletters

Obtener opciones de baja

¿Puedes darte de baja de la lista que envió este correo, cómo, y ya lo hiciste?

POSThttps://g.sendcorex.com/v1command: get_unsubscribe_options

Argumentos

  • idstringobligatorio

    Un correo que recibiste.

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "get_unsubscribe_options",
        args: {
          id: "Vj0xQUJDMTIz"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Respuesta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_unsubscribe_options",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "can_unsubscribe": true,
        "method": "one_click",
        "one_click": true,
        "http": "https://shop.com/u/abc",
        "mailto": "mailto:unsub@shop.com?subject=unsubscribe",
        "list_id": "Shop News <news.shop.com>",
        "list_key": "news.shop.com",
        "from_email": "news@shop.com"
      }
    }
  ]
}

Campos de la respuesta

  • method

    one_click, mailto o http: lo que usará unsubscribe.

  • list_key

    El List-Id cuando el correo lo tiene; si no, el remitente. La misma newsletter desde otra dirección es la misma lista.

  • status

    Aparece cuando ya lo pediste: done, pending o failed.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 401TOKEN_EXPIRED

    El access token expiró. Llama a Refresh Token y repite la solicitud.

  • 401INVALID_TOKEN

    El token está mal formado, es desconocido o fue revocado.

  • 429RATE_LIMITED

    Más de 15 solicitudes/s o 15 en curso para la misma IP + buzón. Espera la cantidad de segundos indicada en Retry-After.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido.

  • CMDNOT_FOUND

    El mensaje, la conversación o la carpeta no existe para este token.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.