Get Suppression List Details

This API allows you to obtain the list of contacts/recipients who've been suppressed (contacts who are excluded from receiving future transmissions).

Request Type

Request URL

https://campaigns.zoho.com/emailapi/v2/recipients/suppression?start_index=1&end_index=500

Content-Type

application/json

List of Request Parameters

Parameters	Data Type	Description
start_index	Integer	Starting index for pagination. Specifies the position in the dataset from which results should begin.
end_index	Integer	Ending index for pagination. Specifies the position in the dataset at which results should stop.
recipients	JSON Array	Optional list of email addresses used to filter the suppression list. When provided, the response will contain only those addresses present in the suppression list.
recipients[].address	String	Email address of the suppressed contact.

List of Response Body Attributes

Parameters	Data Type	Description
response	JSON Object	Contains the response details of the API.
code	Integer	Success or failure code.
message	String	Success or failure message returned by the API.
suppression	JSON Array	List of suppressed contact entries. Each object represents one suppressed email address and its metadata.
suppression[].address	String	Email address of the suppressed contact.
suppression[].additional_data	JSON Object	A user-defined metadata about the recipient (e.g., phone number, country, or internal identifiers).
suppression[].reason	JSON Object	A JSON object specifying the reason for suppression.
suppression[].added_time	Long	Timestamp (milliseconds) when the contact was added to the suppression list.
suppression[].suppression_type	String	Type of suppression. Example: MANUAL
suppression[].zuid	Long	ID of the Zoho user who added the contact to the suppression list. A value of -1 indicates that the suppression was added automatically by the system due to reasons such as hard bounce or spam complaint.
range	JSON Object	Contains pagination range information for the returned results.
range.start_index	Integer	Starting index of the returned data. Indicates the position in the overall dataset where results begin.
range.end_index	Integer	Ending index of the returned data. Indicates the position in the overall dataset where results end.
errors	JSON Array	Present only for failure responses. Contains one or more error objects describing the issue. Each error object contains a code and a message.

Run in Postman View Collection

Sample Request with Filter specified in the Body

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

Sample Response - Success

Copied{
  "response": {
    "code": 200401,
    "message": "Successfully obtained the list of suppressed contacts"
  },
  "suppression": [
    {
      "additional_data": {
        "country": "India"
      },
      "reason": {
         "bounce_code": "554",
         "bounce_reason": "bad-domain"
       },
      "address": "patricia@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "reason": {
        "custom_message": "Custom message",
       },
      "address": "boyle@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "justin@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "musashi@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "jamal@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "john@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "jasmine@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "sam@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "jonathan@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "greg@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "zac@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "matthewe@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "address": "maria@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    }
  ],
  "range": {
    "start_index": 1,
    "end_index": 500
  }
}

Sample Response - Failure

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