Edit DND

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Update an existing suppression (DND) entry in your ZeptoMail account.

Endpoint

Request URL

https://api.zeptomail.com/v1.1/suppressions/{dnd_type} Copied!

Scope

Zeptomail.Suppressions.UPDATECopied!
(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.

Allowed Values :
Show Values
emailCopied!
domainCopied!
Copied!Copy all as JSON Array

- Request Body

application/json
JSON Object
Show Sub-Attributes
valuesarrayMandatory

Array of email addresses or domains to suppress.

actionstringMandatory

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

Allowed Values :
Show Values
rejectCopied!
suppressCopied!
suppress_trackingCopied!
Copied!Copy all as JSON Array
mailagent_keysarrayOptional

Array of Mail Agent keys the suppression applies to.

descriptionstringOptional

Description or reason for adding the suppression entry.

Sample Request

Curl
Java
Python
Deluge
Copied!
curl --request PUT \
  --url https://api.zeptomail.com/v1.1/suppressions/{dnd_type} \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"values":["user@example.com"],"action":"reject","mailagent_keys":["123456abcd78"],"description":"Customer opted out of all marketing emails"}'

Sample Request Body

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Show Sub-Attributes
messagestring
statusstring

- HTTP code 400

Response Body - application/json
JSON Object
Show Sub-Attributes
errorJSON Object
Show Sub-Attributes
codestring
messagestring
statusstring

Possible Response Codes

200HTTP code

Suppression entry updated successfully.

400HTTP code

Bad Request

Sample Response: HTTP 200

Copied!
  {
    "message": "Suppression entry updated successfully.",
    "status": "success"
  }
                
Show full

Sample Response: HTTP 400

Copied!
  {
    "error": {
      "code": "SP_400",
      "message": "Invalid request"
    },
    "status": "failure"
  }
                
Show full