ZOzoho
suppression

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.

get/suppressions/{dnd_type}

Request

  • Base URL
    https://cpaas.zoho.com/v1.1
  • Auth
    • OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.Suppressions.READ
    • or OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.Suppressions.ALL

Path parameters

dnd_type'email' | 'domain' required
Example:email

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

Query parameters

date_fromstring
Example:01/06/2025

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

date_tostring
Example:30/06/2025

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

limitinteger
Example:25

Number of entries to return per request.

mailagent_keystring
Example:123456abcd78

Filter entries by specific Mail Agent key.

offsetinteger

Starting position for pagination.

search_valuestring
Example:user@example.com

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

Response

List of suppression entries.

statusstring

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.