/blacklist/ interface enables the management of a blacklist for email addresses that should be excluded from newsletter mailings.
Corresponding endpoints can be used to add new entries or delete existing ones.
Supported methods
List of all supported methods.| Command/info | Endpoints | GET | POST | PUT | DELETE |
|---|---|---|---|---|---|
| Manage blacklist | blacklist/ |
Using the methods
POST blacklist/add
This endpoint adds an email address to the blacklist. The address is transmitted in the request body and, on successful processing, stored as a hash. The response indicates whether the operation was successful (true) or failed (false).
Access to this endpoint requires a user account with the appropriate permissions.
Example
Request body
Response
Error codes
| Error | Type | Reason |
|---|---|---|
| 401 Unauthorized | Not authorized: you are not logged in or do not have the required permissions to write blacklist data. | |
| 400 Bad Request | Request body could not be loaded. | |
| 400 Bad Request | ”missing” | email was not provided. |
| 400 Bad Request | ”invalidFormat” | email is not a string. |
| 400 Bad Request | ”invalidValue” | email must not be empty. |
| 400 Bad Request | ”unknownDataField” | An unknown field was provided. |
POST blacklist/remove
This endpoint removes an email address from the blacklist. The address is transmitted in the request body. The response indicates whether the operation was successful (true) or failed (false).
Access to this endpoint requires a user account with the appropriate permissions.
Example
Request body
Response
Error codes
| Error | Type | Reason |
|---|---|---|
| 401 Unauthorized | Not authorized: you are not logged in or do not have the required permissions to delete blacklist data. | |
| 400 Bad Request | Request body could not be loaded. | |
| 400 Bad Request | ”missing” | email was not provided. |
| 400 Bad Request | ”invalidFormat” | email is not a string. |
| 400 Bad Request | ”invalidValue” | email must not be empty. |
| 400 Bad Request | ”unknownDataField” | An unknown field was provided. |