Get DND List

Retrieve a list of suppression (DND) entries. The suppression entry can be an email address or a domain. Supports filtering by date, mail agent, and search value.

Endpoint

get /suppressions/{dnd_type}

Copy full URL

Request URL

https://cpaas.zoho.com/v1.1/suppressions/{dnd_type} Copied!

Scope

Zeptomail.Suppressions.READCopied!

(or)

Zeptomail.Suppressions.ALLCopied!

Request Parameters

- Path Parameters

dnd_typestringMandatory

Type of suppression entry. Use email for email address suppression or domain for domain suppression.

Example

Allowed Values :

Show Values ▾

- Query Parameters

date_fromstringOptional

Filter entries added from this date (format: dd/MM/yyyy).

Example

01/06/2025

date_tostringOptional

Filter entries added up to this date (format: dd/MM/yyyy).

Example

30/06/2025

limitintegerOptional

Number of entries to return per request.

Example

mailagent_keystringOptional

Filter entries by specific Mail Agent key.

Example

123456abcd78

offsetintegerOptional

Starting position for pagination.

Example

search_valuestringOptional

Search for a specific email address or domain in the suppression list.

Example

user@example.com

Sample Request

Curl

Java

Python

Deluge

Copied!

curl --request GET \
  --url 'https://cpaas.zoho.com/v1.1/suppressions/{dnd_type}?date_from=01/06/2025&date_to=30/06/2025&limit=25&mailagent_key=123456abcd78&offset=0&search_value=user@example.com' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://cpaas.zoho.com/v1.1/suppressions/{dnd_type}?date_from=01/06/2025&date_to=30/06/2025&limit=25&mailagent_key=123456abcd78&offset=0&search_value=user@example.com"))
        .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("cpaas.zoho.com")

headers = { 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/v1.1/suppressions/{dnd_type}?date_from=01/06/2025&date_to=30/06/2025&limit=25&mailagent_key=123456abcd78&offset=0&search_value=user@example.com", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    parameters = "date_from=value" + "&" + "date_to=value" + "&" + "limit=value" + "&" + "mailagent_key=value" + "&" + "offset=value" + "&" + "search_value=value";

    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://cpaas.zoho.com/v1.1/suppressions/{dnd_type}" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Show Sub-Attributes

dataJSON Array

Show Sub-Attributes

object

created_timestringread-only

Example

2025-06-01T10:00:00Z

actionstringread-only

Example

reject

descriptionstringread-only

Example

Customer opted out

valuestringread-only

Example

user@example.com

statusstringread-only

Example

success

- HTTP code 400

Response Body - application/json

JSON Object

Show Sub-Attributes

errorJSON Object

Show Sub-Attributes

codestringread-only

Example

SP_400

messagestringread-only

Example

Invalid request

statusstringread-only

Example

failure

Sample Response: HTTP 200

Copied!

  {
    "data": [
      {
        "created_time": "2025-06-01T10:00:00Z",
        "action": "reject",
        "description": "Customer opted out",
        "value": "user@example.com"
      }
    ],
    "status": "success"
  }

▼ Show full

Sample Response: HTTP 400

Copied!

  {
    "error": {
      "code": "SP_400",
      "message": "Invalid request"
    },
    "status": "failure"
  }

▼ Show full