POST api/Campaigns/GetBouncebacks
This API allows you to retrieve all the bounce back or undeliverable messages we have received for your emails sent from Digital Communication. This will allow you to see these and act before the email is added to the permanent blocked list of emails.
Request Information
URI Parameters
None.
Body Parameters
BlockedRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDate |
Starting date range. If you do not provide a date, this will default to three years in the past |
date |
None. |
| EndDate |
Ending date range. If you do not provide a date, this will default to the current date and time |
date |
None. |
Request Formats
application/json, text/json
Sample:
{
"StartDate": "2025-10-23T21:06:51.7332577-06:00",
"EndDate": "2025-10-23T21:06:51.7332577-06:00"
}
application/xml, text/xml
Sample:
<BlockedRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <StartDate>2025-10-23T21:06:51.7332577-06:00</StartDate> <EndDate>2025-10-23T21:06:51.7332577-06:00</EndDate> </BlockedRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BouncebackResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Count |
Number of bounceback records |
integer |
None. |
| Bouncebacks |
List of permanently bounceback records |
Collection of Bounceback |
None. |
| IsSuccessful |
Indicator of whether the request was successful |
boolean |
None. |
| ErrorMessage |
This will contain details of the error if it was not successful |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 3",
"Count": 1,
"Bouncebacks": null
}