Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Transactional emails

Get the list of blocked or unsubscribed transactional contacts

get/smtp/blockedContacts

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

Example response

{
  "count": 1,
  "contacts": [
    {
      "email": "john.smith@example.com",
      "senderEmail": "john.smith@example.com",
      "reason": {
        "code": "AdminBlocked",
        "message": "Admin blocked"
      },
      "blockedAt": "2017-05-01T12:30:00Z"
    }
  ]
}