---
title: "Suppress identifier"
method: POST
path: "/orgs/suppressions"
tags: ["Suppressions"]
---

# Suppress identifier

`POST /orgs/suppressions`

## Request

- Base URL: `https://api.useinvent.com`
- URL: `https://api.useinvent.com/orgs/suppressions`
- Auth: HTTP bearer

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

## Request body

- CreateSuppressionSchema: Schema for suppressing a single identifier
  - `channel` 'EMAIL' | 'PHONE', required: The channel an identifier is suppressed on
  - `identifier` string, required: The email or phone number to suppress
  - `reason` 'BOUNCE' | 'COMPLAINT' | 'UNSUBSCRIBE' | 'MANUAL' | 'LEGAL': Defaults to MANUAL
  - `note` string, nullable

## Response `200`

- SuppressionSchema: Schema for the suppression
  - `id` string, required
  - `channel` 'EMAIL' | 'PHONE', required: The channel an identifier is suppressed on
  - `identifier` string, required
  - `reason` 'BOUNCE' | 'COMPLAINT' | 'UNSUBSCRIBE' | 'MANUAL' | 'LEGAL', required: Why the identifier is suppressed
  - `source` 'WEBHOOK' | 'UNSUBSCRIBE_LINK' | 'ADMIN' | 'IMPORT' | 'API', required: What put the identifier on the list
  - `note` string, nullable, required
  - `metadata` SuppressionMetadataSchema, nullable, required: Diagnostic context kept alongside a suppression
    - `diagnostic_code` string
    - `complaint_type` string
    - `feedback` string
    - `broadcast_id` string
    - `import_batch_id` string
  - `created_by` object, nullable, required: Who added the entry. Null when it landed automatically (bounce, complaint, unsubscribe link).
    - `id` string, required
    - `name` string, nullable, required
    - `email` string, email, required
    - `avatar` string, nullable, required
    - `seen_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

---

[API](https://skmtc.dev/useinvent/apis/invent-api.md) · [All operations](https://skmtc.dev/useinvent/apis/invent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useinvent/apis/invent-api/revisions/98824f3fde82?raw)