Get suppression list details
Purpose
This API allows you to obtain the list of email address/domains added to the suppression list.
Request URL
Method : GET
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.READ
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 value
https://api.zeptomail.com/v1.1/suppressions/{zem_dnd_type} - Fetches all the data.
https://api.zeptomail.com//v1.1/suppressions/email?limit=10&offset=2&mailagent_key=ea3.erf.te45rfb - Fetches specified entries alone.
Path parameters
| Parameter | Type | Description |
| type | Email address or Domain | The domain or email address that should be suppressed. |
Query parameters
| Parameter | Type | Description |
| mailagent_keys | Array | Mail Agent alias value. |
| search_value | String | Email address/domain to be fetched. |
| limit | int | Number of suppression entries to be fetched. Default value: 100. |
| offset | int | Place value of the data in the list. Offset value indicates the starting point of the data search in the list. Default value: 0 |
| date_from | date | Entry (date and time) from when the data should be fetched. Format: dd/mm/yyyy, hh:mm AM/PM |
| date_to | date | Entry (date and time) till when the data should be fetched. Format: dd/mm/yyyy, hh:mm AM/PM |
*-Mandatory parameter
Success response
Copied{
"data": [
{
"modified_time": "01 Mar 2024 04:44 PM",
"action": "suppress",
"description": "",
"mailagent_keys": [
"7a4b2d4ae1b57728"
],
"category": "manual",
"value": "reese@zilker.com"
},
{
"modified_time": "01 Mar 2024 04:23 PM",
"action": "suppress",
"description": "Manual suppression",
"mailagent_keys": [
"7a4b2d4ae1b57728"
],
"category": "manual",
"value": "rachel@zilker.com"
},
{
"modified_time": "20 Feb 2024 07:54 PM",
"action": "reject",
"description": "Suppression data",
"category": "manual",
"value": "rob@zilker.com"
}
],
"status": "success"
}