Skip to Content

The Suppression type of the TypeScript SDK, which suppressions.list and suppressions.get take or answer.

type Suppression = {
  accountId?: string
  address: string
  detail: string | null
  eventCount: number
  firstEventAt: number
  lastEventAt: number
  reason: ('complaint' | 'hard_bounce')
  sourceDeliveryId: string | null
}

Fields

FieldTypeDescription
accountIdstringOptional. Sending account whose complaint blocks this recipient; absent for a deployment-global block
addressstringNormalized (lowercased) recipient email address
detailstring | nullDiagnostic error message or feedback detail from the bounce or complaint report
eventCountnumberTotal number of bounce or complaint events recorded for this address
firstEventAtnumberTimestamp of first suppression event in epoch seconds
lastEventAtnumberTimestamp of most recent suppression event in epoch seconds
reason('complaint' | 'hard_bounce')Reason for suppression ('complaint' from FBL report, or 'hard_bounce' from MTA)
sourceDeliveryIdstring | nullDelivery ID that triggered this suppression, or null

Used by

MethodWhat it does
suppressions.listList email suppressions
suppressions.getGet suppression status for an address

Used in

SuppressionList.