Tracking Preferences : Lecture

Obtenir plusieurs

Les préférences de jusqu'à 100 destinataires en une commande. Utilisez-la juste avant un envoi pour décider track_opens et track_clicks par destinataire.

POSThttps://g.sendcorex.com/v1/privacycommand: get_many
i

Nécessite le scope privacy:read sur votre API key.

i

Seuls les destinataires qui ont une préférence sont renvoyés. Une adresse absente de la réponse n'a jamais rien choisi.

Arguments

  • emailsstring[]obligatoire

    1 à 100 adresses de destinataires. Les doublons et les adresses invalides sont ignorés.

    ex. : ["jane.doe@example.com", "marc.dupont@example.fr", "new.person@example.com"]

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "get_many",
        args: {
          emails: [
            "jane.doe@example.com",
            "marc.dupont@example.fr",
            "new.person@example.com"
          ]
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

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_many",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "preferences": [
          {
            "email": "jane.doe@example.com",
            "track_opens": false,
            "track_clicks": true,
            "source": "page",
            "updated_at": "2026-10-24T07:20:12.031Z"
          },
          {
            "email": "marc.dupont@example.fr",
            "track_opens": false,
            "track_clicks": false,
            "source": "api",
            "updated_at": "2026-10-24T07:41:55.508Z"
          }
        ]
      }
    }
  ]
}

Champs de la réponse

  • preferences

    Une entrée par destinataire ayant une préférence.

  • preferences[].email

    L'adresse du destinataire, en minuscules.

  • preferences[].track_opens

    true le destinataire autorise le suivi des ouvertures, false il l'a refusé, null il n'a jamais choisi.

  • preferences[].track_clicks

    true le destinataire autorise le suivi des clics, false il l'a refusé, null il n'a jamais choisi.

  • preferences[].source

    Qui a fait le changement : page (le destinataire, sur la page des préférences de tracking), api (vous, avec Set Preferences) ou dashboard.

  • preferences[].updated_at

    Quand le changement a été fait. ISO 8601, UTC.

Avant l'envoi

Lisez le lot, puis envoyez à chaque destinataire avec le tracking qu'il autorise. Les destinataires sans préférence suivent votre valeur par défaut.

Node.js

const [r] = await call({ command: 'get_many', args: { emails: batch.map((x) => x.email) } });
const prefs = new Map(r.data.preferences.map((p) => [p.email, p]));

for (const x of batch) {
  const p = prefs.get(x.email.toLowerCase());
  await send({
    to: x.email,
    unsubscribe: true,
    track_opens: p?.track_opens === true,   // opt-in: only when allowed
    track_clicks: p?.track_clicks === true,
  });
}
i

Vous n'avez pas besoin de faire cela pour respecter un refus : avec "unsubscribe": true, un destinataire qui a désactivé le tracking n'est jamais suivi. C'est pour les règles d'opt-in, où le tracking doit rester désactivé tant que le destinataire ne l'a pas autorisé.

La réponse

data

{
  "preferences": [
    {
      "email": "jane.doe@example.com",
      "track_opens": false,
      "track_clicks": true,
      "source": "page",
      "updated_at": "2026-10-24T07:20:12.031Z"
    },
    {
      "email": "marc.dupont@example.fr",
      "track_opens": false,
      "track_clicks": false,
      "source": "api",
      "updated_at": "2026-10-24T07:41:55.508Z"
    }
  ]
}

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.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou a été désactivée dans le dashboard.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDMISSING_SCOPE

    L'API key n'a pas le scope de cette commande (`privacy:read` pour lire, `privacy:write` pour modifier).

  • CMDINVALID_ARGS

    Un argument est invalide : `email` manquant ou mal formé, plus de 100 `emails`, `track_opens` qui ne vaut pas `true`/`false`, limit hors limites…

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.