GET /smtp/blockedContacts
Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation). Both startDate and endDate must be provided together when filtering by date range, and neither date can be in the future. Results default to 50 per page (max 100) and are sorted in descending order of record creation unless overridden with the sort parameter.
Servers
- https://api.brevo.com/v3
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
senders[] |
Array | No |
Comma separated list of emails of the senders from which contacts are blocked or unsubscribed |
endDate |
String | No |
Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts |
limit |
Integer | No |
Number of documents returned per page Default value: 50 |
sort |
String | No |
Sort the results in the ascending/descending order of record creation. Default order is descending if Valid values:
Default value: "desc" |
startDate |
String | No |
Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts |
offset |
Integer | No |
Index of the first document on the page Default value: 0 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.