Create Suppression List
This API allows you to add contacts to your suppression list thereby making them to not receive any future transmissions.
Request Type
- POST
Request URL
https://campaigns.zoho.com/emailapi/v1/recipients/suppression
Content-Type
application/json
List of Request Body Attributes
Parameters | Data Type | Description |
recipients* | JSON Array | Recipient list (in the body of the request) ➤ address* - Email address ➤ additional_data - Additional information of the recipient such as Country, Phone. |
List of Response Body Attributes
Parameters | Data Type | Description |
suppressions_added | JSON Array | Contains the list of recipients added to the suppression list. |
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. |
suppressions_already_existing | JSON Array | Indicates that one or more of the recipients are already part of the suppression list. |
errors | JSON Object | Contains the error details of the API such as 'code' and 'message'. |
Possible Errors
Error Code | Description |
400402 | Suppression list not provided. |
400404 | Limit for a single API request has been exceeded. |
400405 | No contacts provided in suppression list. |
Sample Request Payload
Copied{
"recipients":[
{
"address":"patricia@zylker.com",
"additional_data":{
"country":"India"
}
},
{
"address":"boyle@zylker.com",
"additional_data":{
"country":"India"
}
},
{
"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"
}
]
}