Delete Suppression List

This API allows you to remove the recipients from the suppression list.

Request Type

  • DELETE

Request URL

https://campaigns.zoho.com/emailapi/v2/recipients/suppression

Content-Type

application/json

List of Request Body Attributes

ParametersData TypeDescription
recipientsJSON ArrayList of email addresses to be removed from the suppression list.
recipients[].addressStringEmail address of the suppressed contact.

List of Response Body Attributes

ParametersData TypeDescription
responseJSON ObjectContains the response details of the API.
codeIntegerSuccess or failure code.
messageStringSuccess or failure message returned by the API.
errorsJSON ArrayPresent only for failure responses. Contains one or more error objects describing the issue.
Each error object contains a code and a message.
suppressions_ignoredJSON ArrayList of contacts that were not deleted because they were not present in the suppression list.
suppressions_deletedJSON ArrayList of contacts successfully removed from the suppression list.

Possible Errors

Error CodeDescription
400402Suppression list not provided.
400404Limit for a single API request has been exceeded.
400405No contacts provided in suppression list.
Run in PostmanView Collection

Sample Request Payload

Copied{
  "recipients": [
    {
      "address": "patricia@zylker.com"
    },
    {
      "address": "pamela@zylker.com"
    }
  ]
}

Sample Response - Success

Copied{
  "response": {
    "code": 200403,
    "message": "Suppressions deleted successfully"
  },
  "suppressions_ignored": [
    "pamela@zylker.com"
  ],
  "suppressions_deleted": [
    "patricia@zylker.com"
  ]
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 500401,
      "message": "An error occurred in Suppression List API"
    }
  ]
}