transactionalEmails

Get the list of blocked or unsubscribed transactional contacts

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.

get/smtp/blockedContacts

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/smtp/blockedContacts
  • Auth: API key in header api-key

Query parameters

startDatestring

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

endDatestring

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

limitinteger

Number of documents returned per page

offsetinteger

Index of the first document on the page

sendersstring[]

Comma separated list of emails of the senders from which contacts are blocked or unsubscribed

sort'asc' | 'desc'

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

Response

List of blocked or unsubscribed transactional contacts

countinteger

Count of blocked or unsubscribed contact

Changes

No recorded changes to this operation across all 1 revision of this API.