REST eMarketingManager

Über diese Schnittstelle pflegen Sie die Sperrliste des eMarketingManagers aus Ihren eigenen Systemen heraus. Zwei Fälle deckt sie ab: eine Adresse neu sperren und bei einer Adressänderung die neue Adresse nachziehen. Der zweite Fall ist der wichtigere und wird leicht übersehen. Wechselt ein Empfänger seine E-Mail-Adresse, wandert seine Sperre nicht automatisch mit. Ohne diesen Aufruf bekäme er unter der neuen Adresse wieder Post, obwohl er widersprochen hat. Beide Aufrufe brauchen ein Token, siehe REST-Authentifizierung.

Eintrag zur Sperrliste hinzufügen

POST https://www.websale.de/api/emm/addlock

Content-Type: application/json

Eigenschaft	Typ	Beschreibung
`email`	string	E-Mail-Adresse, die gesperrt werden soll
`reason`	string	Begründung, warum die Adresse auf die Liste kommt

{
    "email": "beispiel@websale.de",
    "reason": "telefonisch veranlasst"
}

Mit curl:

curl \
 -X POST \
 -H "Content-Type: application/json" \
 -H "X-Authorization: Bearer eyJhbGciOiJIUzI1Ni...jBhOWMyMmRmNzFkOT==" \
 -d '{
    "email": "beispiel@websale.de",
    "reason": "telefonisch veranlasst"
}' \
"https://www.websale.de/api/emm/addlock"

Bei Erfolg antwortet der Server mit HTTP-Code 200 und leerem Inhalt. Im Fehlerfall kommt ein Code aus der 400er-Reihe.

Eintrag in der Sperrliste aktualisieren

PUT https://www.websale.de/api/emm/changeemail

Content-Type: application/json

Eigenschaft	Typ	Beschreibung
`oldadress`	string	Alte E-Mail-Adresse, nach der in der Sperrliste gesucht wird
`newaddress`	string	Neue E-Mail-Adresse, die eingetragen wird, sofern die alte gefunden wurde

Die neue Adresse kommt nur dann auf die Liste, wenn die alte dort steht. Ein Aufruf für eine nicht gesperrte Adresse bleibt also folgenlos, was den Aufruf unkritisch macht: Sie können ihn bei jeder Adressänderung absetzen, ohne vorher zu prüfen. Bei Erfolg antwortet der Server mit HTTP-Code 200 und leerem Inhalt.

Schnittstellen

Eintrag zur Sperrliste hinzufügen

Eintrag in der Sperrliste aktualisieren

Verwandte Themen

​Eintrag zur Sperrliste hinzufügen

​Eintrag in der Sperrliste aktualisieren

​Verwandte Themen

Eintrag zur Sperrliste hinzufügen

Eintrag in der Sperrliste aktualisieren

Verwandte Themen