REST eMarketingManager

Aufruf

https://www.websale.de/api/emm/*

Es muss (wie bei der Dokumentation für die REST-Befehle für den AuthentServer beschrieben wurde) ein Token im Header übergeben werden.

Aktionen

Eintrag in die Sperrliste hinzufügen

Es kann eine Adresse neu zu der Sperrliste hinzugefügt werden. Dabei muss die eMail-Adresse und der Grund angegeben werden.

HTTP-Request

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

Content-Type

application/json

Authentification Token

benötigt

Request-Body

Request-Body Beispiel

In diesem Beispiel wird die Adresse "beispiel@websale.de" zur Liste hinzugefügt, da der Adressinhaber dies telefonisch veranlasst hat.

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

Response

Bei Erfolg wird HTTP-Code 200 zurückgegeben. Der Content ist leer.

Ist ein Fehler aufgetreten wird ein 400er Code zurückgegeben.

Curl Beispiel

Die Adresse "beispiel@websale.de" wird zur Liste hinzugefügt, da der Adressinhaber dies telefonisch veranlasst hat.

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"

Eintrag in der Sperrliste updaten

Wenn jemand z.B. die eMail-Adresse wechselt muss die Sperrliste (sofern die alte Adresse in der Sperrliste steht) um die neue Adresse erweitert werden.

HTTP-Request

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

Content-Type

application/json

Authentification Token

benötigt

Request-Body

Request-Body Beispiel

Der User hat die Email-Adresse von "beispiel@websale.de" in "neueadresse@websale.de" geändert. Diese soll mit in die Sperrliste eingetragen werden,
sofern die alte Adresse auch in der Liste steht.

{
	"oldaddress": "beispiel@websale.de",
	"newaddress": "neueadresse@websale.de"
}

Antwort

Bei Erfolg wird HTTP-Code 200 zurückgegeben. Der Content ist leer.

Ist ein Fehler aufgetreten wird ein 400er Code zurückgegeben.

Curl Beispiel

Der User hat die Email-Adresse von "beispiel@websale.de" in "neueadresse@websale.de" geändert. Diese soll mit in die Sperrliste eingetragen werden,
sofern die alte Adresse auch in der Liste steht.

curl \
 -X PUT \
 -H "Content-Type: application/json" \
 -H "X-Authorization: Bearer eyJhbGciOiJIUzI1Ni...jBhOWMyMmRmNzFkOT==" \
 -d '{
	"oldaddress": "beispiel@websale.de",
	"newaddress": "neueadresse@websale.de"
}' \
"https://www.websale.de/api/emm/changeemail"