Delete suppression list entry
Purpose
This API allows you to remove email addresses or domains from the suppression list.
Request URL
Method : DELETE
https://api.zeptomail.com/v1.1/suppressions/{type}
OAuth scope
The steps to generate and use OAuth token can be found here.
scope=Zeptomail.Suppressions.All
or
scope=Zeptomail.Suppressions.DELETE
ALL - This will give the basic CRUD access too all the suppression APIs.
Steps to generate the Mail Agent key
Select the Mail Agent that you want to connect to your application.
- Navigate to the SMTP/API tab. Go to the API section.
- Copy the Mail Agent alias from this section.
Mail Agents >> SMTP/API >> Copy the Mail Agent alias
Path parameters
Parameter | Type | Description |
type | Email address or Domain | The domain or email address that should be suppressed. |
Request body
Parameter | Type | Description |
values* | Array | The email address or domain to be deleted. |
*-Mandatory parameter
Failure response parameter
Value | Error | Solution |
DND_102 | Suppression data not found | Ensure you have entered the correct value before proceeding. |
Sample request
Copied{
"values":["rebecc@zilker.com"]
}
Success code
Copied204
Failure response
Copied{
"error": {
"code": "DND_102",
"field": "values",
"message": "Suppression data not found",
"value": "[rebecca@zilker.com]"
},
"status": "failure"
}