/blacklist/ ermöglicht die Verwaltung einer Blacklist für E-Mail-Adressen, die vom Versand von Newslettern ausgeschlossen werden sollen.
Über entsprechende Endpunkte können neue Einträge hinzugefügt oder bestehende gelöscht werden.
Unterstützte Methoden
Angabe aller unterstützten Methoden.| Befehl/Info | Endpunkte | GET | POST | PUT | DELETE |
|---|---|---|---|---|---|
| Blacklist verwalten | blacklist/ |
Verwendung der Methoden
POST blacklist/add
Dieser Endpunkt fügt eine E-Mail-Adresse zur Blacklist hinzu. Die Adresse wird im Request-Body übermittelt und bei erfolgreicher Verarbeitung als Hash gespeichert. Die Antwort gibt an, ob die Operation erfolgreich war (true) oder fehlgeschlagen ist (false).
Der Zugriff auf diesen Endpunkt erfordert ein Benutzerkonto mit entsprechenden Berechtigungen.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Schreiben von Blacklist-Daten. | |
| 400 Bad Request | Request body konnte nicht geladen werden. | |
| 400 Bad Request | ”missing” | email wurde nicht übergeben. |
| 400 Bad Request | ”invalidFormat” | email ist kein String. |
| 400 Bad Request | ”invalidValue” | email darf nicht leer sein. |
| 400 Bad Request | ”unknownDataField” | Es wurde ein unbekanntes Feld übergeben. |
POST blacklist/remove
Dieser Endpunkt entfernt eine E-Mail-Adresse aus der Blacklist. Die Adresse wird im Request-Body übermittelt. Die Antwort gibt an, ob die Operation erfolgreich war (true) oder fehlgeschlagen ist (false).
Der Zugriff auf diesen Endpunkt erfordert ein Benutzerkonto mit entsprechenden Berechtigungen.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Löschen von Blacklist-Daten. | |
| 400 Bad Request | Request body konnte nicht geladen werden. | |
| 400 Bad Request | ”missing” | email wurde nicht übergeben. |
| 400 Bad Request | ”invalidFormat” | email ist kein String. |
| 400 Bad Request | ”invalidValue” | email darf nicht leer sein. |
| 400 Bad Request | ”unknownDataField” | Es wurde ein unbekanntes Feld übergeben. |