> ## Documentation Index
> Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check recipient suppression status.

> Checks whether a recipient is blocked by an active Leadping suppression entry before sending messages or placing calls through the selected channel.



## OpenAPI

````yaml /openapi.json post /suppressions/check
openapi: 3.0.4
info:
  title: Leadping API
  description: >-
    Leadping API for lead intake, messaging, calling, automations, billing,
    business settings, and compliant lead communication workflows.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: v1
servers:
  - url: https://api.leadping.ai
    description: Production
security: []
tags:
  - name: Analytics
  - name: Automations
  - name: Contact
  - name: Conversations
  - name: Dispositions
  - name: Feedback
  - name: Leads
  - name: LeadStatuses
  - name: Notifications
  - name: OutboundDelivery
  - name: Sources
  - name: Suppressions
  - name: Tags
  - name: Users
  - name: Calls
  - name: PhoneNumbers
  - name: Sms
  - name: Telephony
  - name: UserDataExports
  - name: CallEvents
  - name: Events
  - name: SmsEvents
  - name: Businesses
  - name: PaymentMethods
  - name: Transactions
  - name: Usage
  - name: Wallets
paths:
  /suppressions/check:
    post:
      tags:
        - Suppressions
      summary: Check recipient suppression status.
      description: >-
        Checks whether a recipient is blocked by an active Leadping suppression
        entry before sending messages or placing calls through the selected
        channel.
      operationId: Suppressions_Check
      requestBody:
        description: The suppression entry request payload for the operation.
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SuppressionEntryRequest'
              description: Request payload for suppression entry.
          application/*+json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SuppressionEntryRequest'
              description: Request payload for suppression entry.
        required: true
      responses:
        '200':
          description: Returns the suppression check result.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuppressionCheckResult'
                description: >-
                  API response containing suppression check result data returned
                  to callers.
        '400':
          description: The request was invalid or failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    SuppressionEntryRequest:
      type: object
      properties:
        businessId:
          type: string
          description: The business ID associated with this ion entry.
        recipientIdentifier:
          type: string
          description: The recipient identifier value for this ion entry.
          nullable: true
        phoneNumber:
          type: string
          description: The phone number associated with this ion entry.
          nullable: true
        email:
          type: string
          description: The email address associated with this ion entry.
          nullable: true
        channel:
          type: string
          description: The channel value for this ion entry.
        reason:
          type: string
          description: The human-readable reason explaining this ion entry.
          nullable: true
      description: Request payload for suppression entry.
    SuppressionCheckResult:
      type: object
      properties:
        allowed:
          type: boolean
          description: Whether this ion check result allows ed.
        businessId:
          type: string
          description: The business ID associated with this ion check result.
          nullable: true
        recipientIdentifier:
          type: string
          description: The recipient identifier value for this ion check result.
          nullable: true
        normalizedPhoneNumber:
          type: string
          description: The phone number associated with this ion check result.
          nullable: true
        normalizedEmail:
          type: string
          description: The normalized email value for this ion check result.
          nullable: true
        channel:
          type: string
          description: The channel value for this ion check result.
          nullable: true
        suppressionEntryId:
          type: string
          description: The suppression entry ID associated with this ion check result.
          nullable: true
        source:
          type: string
          description: >-
            The source value on the active suppression entry that blocked this
            check.
          nullable: true
        suppressedAt:
          type: string
          description: The date and time the blocking suppression became active.
          format: date-time
          nullable: true
        customerReason:
          type: string
          description: The human-readable customer reason explaining this ion check result.
          nullable: true
      description: >-
        API response containing suppression check result data returned to
        callers.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          description: URI reference that identifies the problem type.
          nullable: true
        title:
          type: string
          description: Short, human-readable summary of the problem.
          nullable: true
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          description: HTTP status code returned for the problem.
          format: int32
          nullable: true
        detail:
          type: string
          description: >-
            Human-readable explanation specific to this occurrence of the
            problem.
          nullable: true
        instance:
          type: string
          description: >-
            URI reference that identifies this specific occurrence of the
            problem.
          nullable: true

````