Skip to main content
POST
Check recipient suppression status.

Body

The suppression entry request payload for the operation.

Request payload for suppression entry.

businessId
string

The business ID associated with this ion entry.

recipientIdentifier
string | null

The recipient identifier value for this ion entry.

phoneNumber
string | null

The phone number associated with this ion entry.

email
string | null

The email address associated with this ion entry.

channel
string

The channel value for this ion entry.

reason
string | null

The human-readable reason explaining this ion entry.

Response

Returns the suppression check result.

API response containing suppression check result data returned to callers.

allowed
boolean

Whether this ion check result allows ed.

businessId
string | null

The business ID associated with this ion check result.

recipientIdentifier
string | null

The recipient identifier value for this ion check result.

normalizedPhoneNumber
string | null

The phone number associated with this ion check result.

normalizedEmail
string | null

The normalized email value for this ion check result.

channel
string | null

The channel value for this ion check result.

suppressionEntryId
string | null

The suppression entry ID associated with this ion check result.

source
string | null

The source value on the active suppression entry that blocked this check.

suppressedAt
string<date-time> | null

The date and time the blocking suppression became active.

customerReason
string | null

The human-readable customer reason explaining this ion check result.