Tracking Preferences: Routen
Run Commands
Der einzige Einstiegspunkt für Tracking-Präferenzen. Senden Sie 1 bis 20 Befehle in einem Request und erhalten Sie ein Ergebnis pro Befehl.
https://g.sendcorex.com/v1/privacyDerselbe Umschlag wie bei Logs, Contacts und Bounces & Complaints. Die Seiten darunter dokumentieren jeden Befehl.
Fehler werden pro Befehl gemeldet. Ein fehlgeschlagener Befehl stoppt die anderen nicht, und der HTTP-Status bleibt 200.
Body-Parameter
commandsobject[]erforderlich1 bis 20 Befehle, der Reihe nach ausgeführt. Der gesamte Body darf bis zu 1 MB groß sein.
commands[].commandstringerforderlichget_preferences,get_many,get_history,list_changesoderset_preferences.commands[].argsobjectoptionalDie Argumente des Befehls.
commands[].idstringoptionalIhr eigener Bezeichner für das Ergebnis. Standard ist der Index (
"0","1"…).
Schnellstart
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);
}Antwort
{
"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"
}
}
}
]
}Antwortfelder
typeImmer
SUCCESS, wenn der Request selbst angenommen wurde.results[].commandDer Befehl, der dieses Ergebnis erzeugt hat.
results[].idDie
id, die Sie gesendet haben, oder der Index des Befehls.results[].typeSUCCESSoderERROR.results[].took_msZeit, die der Befehl im Server gebraucht hat.
results[].dataDie Ausgabe des Befehls. Nur vorhanden, wenn
typeSUCCESSist.results[].code / messageDer Fehler. Nur vorhanden, wenn
typeERRORist.
Authentifizierung
Verwenden Sie den API key, den Sie im Dashboard unter Developers → API Keys erstellen.
AuthorizationSenden Sie
Authorization: <api key>oderAuthorization: Bearer <api key>.privacy:readGet Preferences, Get Many, Get History und List Changes.
privacy:writeSet Preferences.
Mailbox-TokensDer Webmail-Token funktioniert hier nicht. Er wird mit
WRONG_CREDENTIAL_TYPEabgelehnt.Erlaubte IPsHat der Key eine IP-Allowlist, erhalten Requests von anderen IPs
403 IP_NOT_ALLOWED.
Rate limits und Cache
Limits gelten pro IP + API key. Wenn Sie darüber liegen, wird der Request mit HTTP 429 und einem Retry-After-Header abgelehnt.
15 Requests / SekundeSpitze von 15. Antworten aus dem Cache zählen ebenfalls.
15 gleichzeitigHöchstens 15 Requests werden gleichzeitig verarbeitet.
Lese-Cache: 1,5 sDerselbe Lesezugriff innerhalb von 1,5 Sekunden liefert dasselbe Ergebnis. Set Preferences wird nie gecacht.
Fehler
Fehler auf HTTP-Ebene liefern type, code und message. Mit CMD markierte Fehler kommen im Befehlsergebnis zurück, mit HTTP 200.
- 400
INVALID_JSONDer Body ist nicht {"commands":[...]} oder größer als 1 MB.
- 400
INVALID_ARGSDer Request enthält keine Befehle oder mehr als 20.
- 401
MISSING_AUTH_HEADEREs wurde kein Authorization-Header gesendet.
- 401
INVALID_API_KEYDer API key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.
- 401
API_KEY_EXPIREDDer API key hat das im Dashboard festgelegte Ablaufdatum überschritten.
- 401
WRONG_CREDENTIAL_TYPEEs wurde ein Mailbox-Token gesendet. Diese API braucht einen API key aus dem Dashboard.
- 403
IP_NOT_ALLOWEDDer Request kam von einer IP, die nicht zu den erlaubten IPs des Keys gehört.
- 403
ACCOUNT_BLOCKEDDas Konto ist gesperrt.
- 403
MISSING_SCOPEDer Key hat weder `privacy:read` noch `privacy:write`, daher kann kein Befehl ausgeführt werden.
- 429
RATE_LIMITEDMehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API key. Warten Sie die Anzahl Sekunden aus Retry-After ab.
- 503
AUTH_UNAVAILABLEDie Authentifizierung ist vorübergehend nicht verfügbar. Versuchen Sie es erneut.
- CMD
UNKNOWN_COMMANDDer Befehlsname existiert nicht.
- CMD
INTERNALServerfehler. Details werden nur ins Server-Log geschrieben.