Recevoir des e-mails : Newsletters

Obtenir les options de désabonnement

Pouvez-vous vous désabonner de la liste qui a envoyé cet e-mail, comment, et l'avez-vous déjà fait ?

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

Arguments

  • idstringobligatoire

    Un e-mail que vous avez reçu.

Démarrage rapide

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);

Réponse

{
  "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"
      }
    }
  ]
}

Champs de la réponse

  • method

    one_click, mailto ou http : ce que unsubscribe utilisera.

  • list_key

    Le List-Id quand l'e-mail en a un, sinon l'expéditeur. La même newsletter envoyée depuis une autre adresse est la même liste.

  • status

    Présent quand vous avez déjà fait la demande : done, pending ou failed.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 401TOKEN_EXPIRED

    L'access token a expiré. Appelez Refresh Token et relancez la requête.

  • 401INVALID_TOKEN

    Le token est mal formé, inconnu ou révoqué.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 en cours pour la même IP + boîte aux lettres. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDINVALID_ARGS

    Un argument obligatoire est manquant ou invalide.

  • CMDNOT_FOUND

    Le message, la conversation ou le dossier n'existe pas pour ce token.

  • CMDINTERNAL

    Erreur serveur. Le détail est uniquement écrit dans le log du serveur.