REST eMarketingManager (EN)
API eMarketingManager
Add entry to the blacklist
An address can be added to the blacklist. The email address and the reason must be specified.
Request
POST https://www.websale.de/api/emm/addlock
Content-Type
application/json
Authorization-Token
requires
Request-Body
Property | Type | Description |
---|---|---|
string | Email address to be added to the blacklist | |
reason | string | Reason text why the address should be added to the list |
Example request body
In this example the address "beispiel@websale.de" will be added to the list because the address owner has requested this by phone.
{
"email": "beispiel@websale.de",
"reason": "telefonisch veranlasst"
}
Example cURL
The address "beispiel@websale.de" will be added to the list, because the address owner has initiated this by phone.
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
If successful, HTTP code 200 is returned. The content is empty.
If an error occurred, a 400 code is returned.
Update entry in the blacklist
If someone changes e.g. the email address the blacklist (if the old address is in the blacklist) must be updated with the new address.
Request
Content-Type
application/json
Authorization-Token
requires
Request-Body
Property | Type | Description |
---|---|---|
oldadress | string | Old email address to search for in the blacklist |
newaddress | string | New email address to be added to the blacklist if oldaddress is found in the list |
Example request body
The user has changed the email address from "beispiel@websale.de" to "neueadresse@websale.de". This address should be added to the blacklist, if the old address is also in the list.
Example cURL
The user has changed the email address from "beispiel@websale.de" to "neueadresse@websale.de". This should be added to the blacklist, if the old address is also in the list.
Response
If successful, HTTP code 200 is returned. The content is empty.
If an error occurred, a 400 code is returned.