Tracking Preferences: Lesen

Einstellungen abrufen

Die Wahl eines Empfängers zum Tracking von Öffnungen und Klicks. Ein Lookup per Adresse, kein Scan.

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

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

i

preference ist null, wenn der Empfänger die Seite für Tracking-Präferenzen nie geöffnet hat und Sie nie etwas für ihn gesetzt haben.

Argumente

  • emailstringerforderlich

    Die Empfängeradresse. Groß-/Kleinschreibung spielt keine Rolle.

    z. B. "jane.doe@example.com"

Schnellstart

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

Antwort

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

Antwortfelder

  • preference

    Die Präferenz unten oder null, wenn es keine gibt.

  • preference.email

    Die Empfängeradresse, in Kleinbuchstaben.

  • preference.track_opens

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

  • preference.track_clicks

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

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

  • preference.updated_at

    Wann die Änderung erfolgte. ISO 8601, UTC.

Wie es sich auf Ihre Sendungen auswirkt

  • Ablehnung hat immer Vorrang

    Wenn track_opens oder track_clicks false ist, wird dieses Tracking aus der E-Mail weggelassen, auch wenn Ihr Versand es mit "track_opens": true anfordert.

  • Nie gewählt

    Wenn der Wert null ist (oder der Empfänger gar keine Präferenz hat), entscheidet Ihr Versand, genau wie bisher.

  • Erfordert unsere Abmelde-Engine

    Präferenzen gelten für Sendungen mit "unsubscribe": true. Das fügt auch den Präferenz-Link in die E-Mail ein.

  • Ihr Standard

    Für Opt-in-Regeln (zum Beispiel Frankreich) senden Sie "track_opens": false und "track_clicks": false, bis der Empfänger es erlaubt hat, und lesen die Präferenz vor dem Senden mit Get Many.

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.