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

  • GET

Request URL

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

Content-Type

application/json

List of Request Parameters

ParametersData TypeDescription
start_indexIntegerStarting index of the number of objects to be obtained.
end_indexIntegerEnding index of the number of objects to be obtained.
recipientsJSON Array

Recipient list (in the body of the request), to filter the result. If this is provided, result of this call will consist only of those addresses if present in the Suppression list.

➤ address* - Email address

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.
suppressionJSON Array

Contains the contact/recipient details of the suppression list.

➤ additional_data - Additional information of the recipient such as Country, Phone.

➤ address - Email address of the contact/recipient.

➤ added_time - Time (in milliseconds) at which the contact was added to this list.

➤ suppression_type - The type of suppression. Example: MANUAL.

➤ zuid - User ID of the Zoho Account's user from whose account this API was called.

rangeJSON ObjectContains information about start and end index.
start_indexIntegerStarting index of the data range being returned. Indicates the position in the overall data set where the returned data begins.
end_indexIntegerEnding index of the data range being returned. Indicates the position in the overall data set where the returned data ends.
errorsJSON ObjectContains the error details of the API such as 'code' and 'message'
Run in PostmanView 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"
      },
      "address": "patricia@zylker.com",
      "added_time": 1680612284111,
      "modified_time": 1680612284111,
      "suppression_type": "MANUAL",
      "zuid": 16304095
    },
    {
      "additional_data": {
        "country": "India"
      },
      "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"
    }
  ]
}