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
...
| Excerpt |
|---|
Über die REST-Schnittstelle fügen Sie neue Einträge zur Sperrliste des eMarketingManagers hinzu oder aktualisieren bestehende E-Mail-Adressen. |
Wenn eine E-Mail-Adresse vom Kunden geändert wurde, wird auch im eMM diese Mail-Adresse auf die Sperrliste gesetzt, sofern die alte Mail-Adresse auf der Sperrliste vorhanden ist.
...
Inhaltsverzeichnis
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
API eMarketingManager
Eintrag zur Sperrliste hinzufügen (emm/addlock)
Adressen können zur Sperrliste hinzugefügt werden. Dabei müssen die E-Mail-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
Eigenschaft | Typ | Beschreibung |
|---|---|---|
string |
E-Mail-Adresse, die zur Sperrliste |
hinzugefügt werden soll | ||
reason | string | Begründungstext |
, warum 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 | ||
|---|---|---|
| ||
{
"email": "beispiel@websale.de",
"reason": "telefonisch veranlasst"
} |
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 (emm/changeemail)
Wenn jemand z. B. die eMailE-Mail-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
Eigenschaft | Typ | Beschreibung |
|---|---|---|
oldadress | string | Alte |
E-Mail-Adresse, nach der in der Sperrliste gesucht werden soll | ||
newaddress | string | Neue |
E-Mail-Adresse, die in die Sperrliste eingetragen werden soll, wenn die oldaddress in der Liste gefunden wurde |
Beispiel Request-Body
...
Der User hat die EmailE-Mail-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 | ||
|---|---|---|
| ||
{
"oldaddress": "beispiel@websale.de",
"newaddress": "neueadresse@websale.de"
} |
Beispiel cURL
Der User hat die E-Mail-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.
| Include Page | ||||
|---|---|---|---|---|
|