Create Suppression List

This API allows you to add contacts to your suppression list thereby making them to not receive any future transmissions.

Note: Upon a hard bounce, the contact is automatically added to the suppression list.

Request Type

  • POST

Request URL

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

Content-Type

application/json

List of Request Body Attributes

ParametersData TypeDescription
recipientsJSON ArrayAn array containing information about the recipients to be suppressed.
recipients[].addressStringEmail address of the recipient to be suppressed.
recipients[].additional_dataJSON ObjectA user-defined JSON object containing additional contextual information (e.g. country, phone, or internal tags). This field is optional and may include arbitrary key-value pairs for reference purposes.
recipients[].reasonJSON ObjectA user-defined JSON object specifying the reason for suppression. This field is optional and may include arbitrary key-value pairs for reference purposes.

List of Response Body Attributes

ParametersData TypeDescription
suppressions_addedJSON ArrayContains the list of recipients added to the suppression list.
responseJSON ObjectContains the response details of the API.
codeIntegerSuccess or failure code.
messageStringSuccess or failure message returned by the API.
suppressions_already_existingJSON ArrayIndicates that one or more of the recipients are already part of the suppression list.
errorsJSON ObjectContains the error details of the API such as 'code' and 'message'.

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",
      "additional_data":{
        "country":"India"
      },
      "reason": {
          "bounce_code": "550",
          "bounce_reason": "bad-mailbox"
       }
    },
    {
      "address":"boyle@zylker.com",
      "additional_data":{
        "country":"India"
      },
      "reason": {
         "message_1": "Your custom message 1",
         "message_2": "Your custom message 2"
       }
    },
    {
      "address":"julia@zylker.com",
      "additional_data":{
        "country":"India"
      }
    },
    {
      "address":"justin@zylker.com",
      "additional_data":{
        "country":"India"
      }
    },
    {
      "address":"john@zylker.com",
      "additional_data":{
        "country":"India"
      }
    }
  ]
}

Sample Response - Success

Copied{
  "suppressions_added": [
    "boyle@zylker.com",
    "julia@zylker.com",
    "justin@zylker.com",
    "john@zylker.com"
  ],
  "response": {
    "code": 200402,
    "message": "Suppressions added successfully"
  },
  "suppressions_already_existing": [
    "patricia@zylker.com"
  ]
}

Sample Response - Failure

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