ZOzoho
suppression

Create DND

Add a new suppression (DND) entry. The suppression entry can be an email address or a domain. Once added, emails will not be delivered to the suppressed address or domain.

post/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.CREATE
    • 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.

Request body

valuesstring[] required

Array of email addresses or domains to suppress.

action'reject' | 'suppress' | 'suppress_tracking' required

Suppression action. Allowed values: reject, suppress, suppress_tracking.

mailagent_keysstring[]

Array of Mail Agent keys the suppression applies to.

descriptionstring

Description or reason for adding the suppression entry.

Example request

{
  "values": [
    "user@example.com"
  ],
  "action": "reject",
  "mailagent_keys": [
    "123456abcd78"
  ],
  "description": "Customer opted out of all marketing emails"
}

Response

Suppression entry created successfully.

messagestring
statusstring

Example response

{
  "message": "Suppression entry added successfully.",
  "status": "success"
}

Changes

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