Suppressions

Check whether a recipient is suppressed

The result reflects the effective compliance state after normalization, organization scoping, and suppression-history checks.

post/suppressions/check

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/suppressions/check
  • Auth: HTTP bearer

Request body

recipientIdentifierstring nullable

Optional provider or customer identifier that uniquely identifies the recipient.

phoneNumberstring nullable

Recipient phone number to suppress or check, preferably in E.164 format.

emailstring email nullable

Recipient email address to suppress or check.

channelstring

Communication channel affected by the suppression, such as SMS, voice, email, or all channels.

reasonstring nullable

Human-readable reason for creating or releasing the suppression.

Response

Returns the suppression check result.

allowedboolean

Whether outreach to the recipient is allowed for the requested channel.

organizationIdstring nullable

Identifier of the organization whose suppression list was checked.

recipientIdentifierstring nullable

Provider or customer identifier used to match the recipient.

normalizedPhoneNumberstring nullable

Phone number used for matching, normalized to a consistent format.

normalizedEmailstring email nullable

Email address used for matching, normalized for comparison.

channelstring nullable

Communication channel evaluated by the suppression check.

suppressionEntryIdstring nullable

Identifier of the active suppression that blocked contact, when one matched.

sourcestring nullable

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

suppressedAtstring date-time nullable

The date and time the blocking suppression became active.

customerReasonstring nullable

Customer-safe explanation of why contact is blocked or allowed.

Changes

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