Tracking Preferences: Lesen

Mehrere abrufen

Die Präferenzen von bis zu 100 Empfängern in einem Befehl. Nutzen Sie es direkt vor einem Versand, um track_opens und track_clicks pro Empfänger festzulegen.

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

Erfordert den Scope privacy:read für Ihren API key.

i

Nur Empfänger mit einer Präferenz werden zurückgegeben. Eine Adresse, die in der Antwort fehlt, hat nie etwas gewählt.

Argumente

  • emailsstring[]erforderlich

    1 bis 100 Empfängeradressen. Duplikate und ungültige Adressen werden ignoriert.

    z. B. ["jane.doe@example.com", "marc.dupont@example.fr", "new.person@example.com"]

Schnellstart

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

Antwort

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

Antwortfelder

  • preferences

    Ein Eintrag pro Empfänger mit einer Präferenz.

  • preferences[].email

    Die Empfängeradresse, in Kleinbuchstaben.

  • preferences[].track_opens

    true der Empfänger erlaubt das Tracking von Öffnungen, false er hat es abgelehnt, null er hat nie gewählt.

  • preferences[].track_clicks

    true der Empfänger erlaubt das Tracking von Klicks, false er hat es abgelehnt, null er hat nie gewählt.

  • preferences[].source

    Wer die Änderung vorgenommen hat: page (der Empfänger, auf der Seite für Tracking-Präferenzen), api (Sie, mit Set Preferences) oder dashboard.

  • preferences[].updated_at

    Wann die Änderung erfolgte. ISO 8601, UTC.

Vor dem Senden

Lesen Sie den Batch und senden Sie dann jedem Empfänger mit dem Tracking, das er erlaubt. Empfänger ohne Präferenz folgen Ihrem Standard.

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

Das ist nicht nötig, um eine Ablehnung zu respektieren: Mit "unsubscribe": true wird ein Empfänger, der das Tracking ausgeschaltet hat, nie getrackt. Das ist für Opt-in-Regeln gedacht, bei denen das Tracking aus bleiben muss, bis der Empfänger es erlaubt.

Die Antwort

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

Fehler

Fehler auf HTTP-Ebene liefern type, code und message. Mit CMD markierte Fehler kommen im Befehlsergebnis zurück, mit HTTP 200.

  • 401INVALID_API_KEY

    Der API key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.

  • 429RATE_LIMITED

    Mehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API key. Warten Sie die Anzahl Sekunden aus Retry-After ab.

  • CMDMISSING_SCOPE

    Der API key hat nicht den Scope dieses Befehls (`privacy:read` zum Lesen, `privacy:write` zum Ändern).

  • CMDINVALID_ARGS

    Ein Argument ist ungültig: fehlende oder fehlerhafte `email`, mehr als 100 `emails`, `track_opens`, das nicht `true`/`false` ist, limit außerhalb des Bereichs…

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.