# Suppression

URL: /business/nouns/suppression · Id: `noun:suppression`

> A Suppression is an address a Company never sends commercial Messages to, read before every send from any of its Startups.

A Suppression is an address a [Company](/business/nouns/company) never sends commercial [Messages](/business/nouns/message) to, read before every send from any of its [Startups](/business/nouns/startup).

## Properties
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `address` | `string` | Yes | The email address or phone number. |
| `reason` | `string` | No | Why it is suppressed, such as an opt-out or a bounce. |

## Object
```json
{
  "$id": "https://api.sb/patentpad.com/suppressions/suppression_1",
  "$type": "Suppression",
  "address": "Example address",
  "reason": "Example reason"
}
```

## Relationships
- <a id="rel-kept-by"></a>A Suppression **is kept by** one [Company](/business/nouns/company): a [Company](/business/nouns/company)’s Suppressions bind every [Startup](/business/nouns/startup) it holds: no commercial [Message](/business/nouns/message) goes to a suppressed address. `keptBy`, inverse [`keeps`](/business/nouns/company#rel-keeps).

## Verbs
| Verb | Description | Subject | Event | Class |
| --- | --- | --- | --- | --- |
| <a id="create"></a>[Suppression.create](/business/nouns/suppression/create) | Creates a Suppression. Inherited from [Noun](/business/nouns/noun). | None. | `Suppression.created` | Two-way: `try`, `send`, `do` |
| <a id="get"></a>[Suppression.get](/business/nouns/suppression/get) | Returns one Suppression by id. Inherited from [Noun](/business/nouns/noun). | None. | None. | Read: `try`, `do` |
| <a id="list"></a>[Suppression.list](/business/nouns/suppression/list) | Returns Suppressions, newest first, one page at a time. Inherited from [Noun](/business/nouns/noun). | None. | None. | Read: `try`, `do` |

A Suppression is kept forever and never edited: it has no `update` or `delete`.

## Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.

| Operation | `owner` | `admin` | `member` | `viewer` |
| --- | --- | --- | --- | --- |
| `Suppression.create` | Yes | Yes | Yes | No |
| `Suppression.get` | Yes | Yes | Yes | Yes |
| `Suppression.list` | Yes | Yes | Yes | Yes |

## Call it

**Ask**

```text
Add a suppression to ShiftNote.
```

**API**

```bash
curl -X POST https://api.sb/shiftnote.app/suppressions \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"Example address"}'
```

```json
{
  "api": "https://api.sb/shiftnote.app",
  "suppression": {
    "$id": "https://api.sb/shiftnote.app/suppressions/suppression_1",
    "$type": "Suppression",
    "address": "Example address"
  },
  "action": {
    "$id": "https://api.sb/shiftnote.app/actions/action_1",
    "operation": "Suppression.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/shiftnote.app/actions/action_1"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const suppression = await $.Suppression.create({ address: 'Example address' })
```

**CLI**

```bash
npx startup-builder do Suppression.create --json '{"address":"Example address"}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Suppression.create({ address: 'Example address' })"
  }
}
```

## Example
A florist unsubscribes from one sibling's newsletter. The Suppression, kept by their [Company](/business/nouns/company), stops commercial Messages to her from every Startup it holds, with `reason: unsubscribed`.