Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API eMarketingManager

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.

...

Request

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

Content-Type

application/json

Authorization-Token

benötigt

Request-Body

EigenschaftTypBeschreibung
emailstringEmail-Adresse, die zur Sperrliste hinzugefüt werden soll
reasonstringBegründungstext wieso die Adresse zur Liste hinzugefügt werden soll

Beispiel Request-Body

...

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

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

Response

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

...

...

Beispiel cURL

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

Code Block
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"

Response

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

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

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.

...

Request

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

Content-Type

application/json

Authorization-Token

benötigt

Request-Body

EigenschaftTypBeschreibung
oldadressstringAlte Email-Adresse, nach der in der Sperrliste gesucht werden soll
newaddressstringNeue Emal-Adresse, die in die Sperrliste eingetragen werden soll wenn die oldaddress in der Liste gefunden wurde

Beispiel Request-Body

...

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.

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

Antwort

...

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

...

Beispiel cURL 

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.

Code Block
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"

Response

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

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