Tracking Preferences : Lecture
Obtenir les préférences
Le choix de suivi des ouvertures et des clics d'un destinataire. Une recherche par adresse, sans scan.
https://g.sendcorex.com/v1/privacycommand: get_preferencesNécessite le scope privacy:read sur votre API key.
preference vaut null lorsque le destinataire n'a jamais ouvert la page des préférences de tracking et que vous n'avez jamais rien défini pour lui.
Arguments
emailstringobligatoireL'adresse du destinataire. La casse n'a pas d'importance.
ex. :
"jane.doe@example.com"
Démarrage rapide
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/privacy',
{
commands: [
{
command: "get_preferences",
args: {
email: "jane.doe@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_preferences",
"id": "0",
"type": "SUCCESS",
"took_ms": 6,
"data": {
"preference": {
"email": "jane.doe@example.com",
"track_opens": false,
"track_clicks": true,
"source": "page",
"updated_at": "2026-10-24T07:20:12.031Z"
}
}
}
]
}Champs de la réponse
preferenceLa préférence ci-dessous, ou
nulls'il n'y en a pas.preference.emailL'adresse du destinataire, en minuscules.
preference.track_openstruele destinataire autorise le suivi des ouvertures,falseil l'a refusé,nullil n'a jamais choisi.preference.track_clickstruele destinataire autorise le suivi des clics,falseil l'a refusé,nullil n'a jamais choisi.preference.sourceQui a fait le changement :
page(le destinataire, sur la page des préférences de tracking),api(vous, avec Set Preferences) oudashboard.preference.updated_atQuand le changement a été fait. ISO 8601, UTC.
Impact sur vos envois
Le refus l'emporte toujoursQuand
track_opensoutrack_clicksvautfalse, ce tracking est retiré de l'e-mail même si votre envoi le demande avec"track_opens": true.Jamais choisiQuand la valeur est
null(ou que le destinataire n'a aucune préférence), c'est votre envoi qui décide, exactement comme avant.Nécessite notre moteur de désabonnementLes préférences s'appliquent aux envois avec
"unsubscribe": true. C'est aussi ce qui place le lien des préférences dans l'e-mail.Votre valeur par défautPour les règles d'opt-in (par exemple en France), envoyez
"track_opens": falseet"track_clicks": falsetant que le destinataire ne l'a pas autorisé, et lisez la préférence avec Get Many avant l'envoi.
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.
- 401
INVALID_API_KEYL'API key n'existe pas, a été révoquée ou a été désactivée dans le dashboard.
- 429
RATE_LIMITEDPlus 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.
- CMD
MISSING_SCOPEL'API key n'a pas le scope de cette commande (`privacy:read` pour lire, `privacy:write` pour modifier).
- CMD
INVALID_ARGSUn argument est invalide : `email` manquant ou mal formé, plus de 100 `emails`, `track_opens` qui ne vaut pas `true`/`false`, limit hors limites…
- CMD
INTERNALErreur serveur. Le détail n'est écrit que dans le log du serveur.