Email APIBlocked email recipients

Get the list of blocked or unsubscribed transactional contacts

View as Markdown
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.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

startDatestringOptional

Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts

endDatestringOptional

Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts

limitlongOptional0-100Defaults to 50
Number of documents returned per page
offsetlongOptionalDefaults to 0
Index of the first document on the page
senderslist of stringsOptional
Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:

Response

List of blocked or unsubscribed transactional contacts
contactslist of objectsOptional
countlongOptional
Count of blocked or unsubscribed contact

Errors

400
Bad Request Error