Tracking Preferences : Routes

Run Commands

Le point d'entrée unique pour les préférences de tracking. Envoyez de 1 à 20 commandes en une requête et obtenez un résultat par commande.

POSThttps://g.sendcorex.com/v1/privacy
i

Même enveloppe que Logs, Contacts et Bounces & Complaints. Les pages sous celle-ci documentent chaque commande.

i

Les erreurs sont signalées par commande. Une commande qui échoue n'arrête pas les autres, et le statut HTTP reste 200.

Paramètres du corps

  • commandsobject[]obligatoire

    1 à 20 commandes, exécutées dans l'ordre. Le corps entier peut faire jusqu'à 1 MB.

  • commands[].commandstringobligatoire

    get_preferences, get_many, get_history, list_changes ou set_preferences.

  • commands[].argsobjectfacultatif

    Les arguments de la commande.

  • commands[].idstringfacultatif

    Votre propre identifiant pour le résultat. Par défaut, l'index ("0", "1"…).

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "set_preferences",
        id: "set",
        args: {
          email: "jane.doe@example.com",
          track_opens: false
        }
      },
      {
        command: "get_preferences",
        id: "get",
        args: {
          email: "jane.doe@example.com"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

for (const result of response.data.results) {
  if (result.type !== 'SUCCESS') console.error(result.id, result.code, result.message);
  else console.log(result.id, result.data);
}

Réponse

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "set_preferences",
      "id": "set",
      "type": "SUCCESS",
      "took_ms": 9,
      "data": {
        "changed": true,
        "preference": {
          "email": "jane.doe@example.com",
          "track_opens": false,
          "track_clicks": true,
          "source": "api",
          "updated_at": "2026-10-24T07:20:12.031Z"
        }
      }
    },
    {
      "command": "get_preferences",
      "id": "get",
      "type": "SUCCESS",
      "took_ms": 3,
      "data": {
        "preference": {
          "email": "jane.doe@example.com",
          "track_opens": false,
          "track_clicks": true,
          "source": "api",
          "updated_at": "2026-10-24T07:20:12.031Z"
        }
      }
    }
  ]
}

Champs de la réponse

  • type

    Toujours SUCCESS lorsque la requête elle-même a été acceptée.

  • results[].command

    La commande qui a produit ce résultat.

  • results[].id

    L'id que vous avez envoyé, ou l'index de la commande.

  • results[].type

    SUCCESS ou ERROR.

  • results[].took_ms

    Le temps passé par la commande dans le serveur.

  • results[].data

    La sortie de la commande. Présente uniquement lorsque type vaut SUCCESS.

  • results[].code / message

    L'erreur. Présente uniquement lorsque type vaut ERROR.

Authentification

Utilisez l'API key que vous créez dans le dashboard, sous Developers → API Keys.

  • Authorization

    Envoyez Authorization: <api key> ou Authorization: Bearer <api key>.

  • privacy:read

    Get Preferences, Get Many, Get History et List Changes.

  • privacy:write

    Set Preferences.

  • Tokens de mailbox

    Le token du webmail ne fonctionne pas ici. Il est rejeté avec WRONG_CREDENTIAL_TYPE.

  • IP autorisées

    Si la key a une liste d'IP autorisées, les requêtes provenant d'autres IP reçoivent 403 IP_NOT_ALLOWED.

Rate limits et cache

Les limites s'appliquent par IP + API key. Au-delà, la requête est rejetée avec un HTTP 429 et un header Retry-After.

  • 15 requêtes / seconde

    Pic de 15. Les réponses servies depuis le cache comptent aussi.

  • 15 simultanées

    Au maximum 15 requêtes traitées en même temps.

  • Cache de lecture : 1,5 s

    La même lecture à moins de 1,5 seconde d'intervalle renvoie le même résultat. Set Preferences n'est jamais mis en cache.

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.

  • 400INVALID_JSON

    Le corps n'est pas {"commands":[...]} ou dépasse 1 MB.

  • 400INVALID_ARGS

    La requête ne contient aucune commande ou plus de 20.

  • 401MISSING_AUTH_HEADER

    Aucun header Authorization n'a été envoyé.

  • 401INVALID_API_KEY

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

  • 401API_KEY_EXPIRED

    L'API key a dépassé la date d'expiration définie dans le dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Un token de mailbox a été envoyé. Cette API nécessite une API key du dashboard.

  • 403IP_NOT_ALLOWED

    La requête provient d'une IP qui ne figure pas parmi les IP autorisées de la key.

  • 403ACCOUNT_BLOCKED

    Le compte est bloqué.

  • 403MISSING_SCOPE

    La key n'a ni `privacy:read` ni `privacy:write`, donc aucune commande ne peut s'exécuter.

  • 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.

  • 503AUTH_UNAVAILABLE

    L'authentification est temporairement indisponible. Réessayez.

  • CMDUNKNOWN_COMMAND

    Le nom de la commande n'existe pas.

  • CMDINTERNAL

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