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

# Suppress an Identifier

> Add an email or phone number to the org suppression list. Suppressing an identifier that is already on the list refreshes its reason.



## OpenAPI

````yaml https://api.useinvent.com/openapi.json post /orgs/{org_id}/suppressions
openapi: 3.1.0
info:
  version: 1.0.0
  title: Invent API
servers:
  - url: https://api.useinvent.com
security:
  - bearerAuth: []
paths:
  /orgs/{org_id}/suppressions:
    post:
      tags:
        - Orgs Suppressions
      summary: Suppress an Identifier
      description: >-
        Add an email or phone number to the org suppression list. Suppressing an
        identifier that is already on the list refreshes its reason.
      parameters:
        - schema:
            type: string
          required: true
          description: The ID of the org
          name: org_id
          in: path
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSuppressionSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateSuppressionSchema'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionSchema'
components:
  schemas:
    CreateSuppressionSchema:
      allOf:
        - $ref: '#/components/schemas/SuppressionOptionSchema'
        - type: object
          properties:
            reason:
              allOf:
                - $ref: '#/components/schemas/SuppressionReasonSchema'
                - description: Defaults to MANUAL
            note:
              type:
                - string
                - 'null'
              maxLength: 500
      description: Schema for suppressing a single identifier
    SuppressionSchema:
      type: object
      properties:
        id:
          type: string
        channel:
          $ref: '#/components/schemas/SuppressionChannelSchema'
        identifier:
          type: string
        reason:
          $ref: '#/components/schemas/SuppressionReasonSchema'
        source:
          $ref: '#/components/schemas/SuppressionSourceSchema'
        note:
          type:
            - string
            - 'null'
        metadata:
          $ref: '#/components/schemas/SuppressionMetadataSchema'
        created_by:
          allOf:
            - $ref: '#/components/schemas/UserLimitedSchema'
            - type:
                - object
                - 'null'
              description: >-
                Who added the entry. Null when it landed automatically (bounce,
                complaint, unsubscribe link).
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - channel
        - identifier
        - reason
        - source
        - note
        - metadata
        - created_by
        - created_at
        - updated_at
      description: Schema for the suppression
    SuppressionOptionSchema:
      type: object
      properties:
        channel:
          $ref: '#/components/schemas/SuppressionChannelSchema'
        identifier:
          type: string
          maxLength: 320
          description: The email or phone number to suppress
      required:
        - channel
        - identifier
      description: A single identifier to suppress
    SuppressionReasonSchema:
      type: string
      enum:
        - BOUNCE
        - COMPLAINT
        - UNSUBSCRIBE
        - MANUAL
        - LEGAL
      description: Why the identifier is suppressed
    SuppressionChannelSchema:
      type: string
      enum:
        - EMAIL
        - PHONE
      description: The channel an identifier is suppressed on
    SuppressionSourceSchema:
      type: string
      enum:
        - WEBHOOK
        - UNSUBSCRIBE_LINK
        - ADMIN
        - IMPORT
        - API
      description: What put the identifier on the list
    SuppressionMetadataSchema:
      type:
        - object
        - 'null'
      properties:
        diagnostic_code:
          type: string
          maxLength: 1024
        complaint_type:
          type: string
          maxLength: 128
        feedback:
          type: string
          maxLength: 1024
        broadcast_id:
          type: string
        import_batch_id:
          type: string
      description: Diagnostic context kept alongside a suppression
    UserLimitedSchema:
      type: object
      properties:
        id:
          type: string
        name:
          type:
            - string
            - 'null'
        email:
          type: string
          format: email
        avatar:
          type:
            - string
            - 'null'
        seen_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - name
        - email
        - avatar
        - seen_at
      description: The assigned user for the conversation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Bearer token authentication using your API key

````