Suppressions

Create or reactivate a recipient suppression

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

post/suppressions

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/suppressions
  • 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

The suppression entry response was created successfully.

isDemoboolean
idstring nullable

Unique Leadping identifier for the suppression entry.

organizationIdstring nullable

Identifier of the organization that owns the suppression entry.

recipientIdentifierstring nullable

Provider or customer identifier used to recognize the suppressed recipient.

leadNamestring nullable

Display name of the associated lead, when available.

leadEmailstring email nullable

The associated lead's email address, used for Gravatar fallback.

leadAvatarUrlstring uri nullable

The associated lead's profile image URL, when available.

normalizedPhoneNumberstring nullable

Suppressed phone number normalized to a consistent format.

normalizedEmailstring email nullable

Suppressed email address normalized for matching.

channelstring nullable

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

sourcestring nullable

System or workflow that created the suppression.

statusstring nullable

Current lifecycle state, such as active or released.

reasonstring nullable

Human-readable reason the recipient was suppressed or subsequently released.

suppressedAtstring date-time nullable

UTC timestamp when the suppression became active.

releasedAtstring date-time nullable

UTC timestamp when the suppression was released, or null while it remains active.

Changes

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