# Suppression programs

URL: /code/mcp/suppression · Id: `page:code/mcp/suppression`

> Every Suppression Verb as an MCP do program, with its inputs, result, refusals and an example.

Reference for [Suppression](/business/nouns/suppression).

| Noun | System | Run by |
| --- | --- | --- |
| [Suppression](/business/nouns/suppression) | [Mailboxes](/systems/mailboxes) | [Customer Lead](/agents/customer/customer-lead) |

### Suppression.create
Creates a Suppression. [Verb page](/business/nouns/suppression/create?interface=mcp).

```text
do: return await $.Suppression.create(input)
```

Emits `Suppression.created`.

**Inputs**

| Input | 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. |
| `company` | [Company](/business/nouns/company) | No | A Company’s Suppressions bind every Startup it holds: no commercial Message goes to a suppressed address. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `suppression` | [Suppression](/business/nouns/suppression) | Yes | The Suppression. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

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

### Suppression.get
Returns one Suppression by id. [Verb page](/business/nouns/suppression/get?interface=mcp).

```text
do: return await $.Suppression.get(input)
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Suppression. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `suppression` | [Suppression](/business/nouns/suppression) | Yes | The Suppression. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Suppression.get({ id: 'suppression_Ssbq90xC9R' })"
  }
}
```

### Suppression.list
Returns Suppressions, newest first, one page at a time. [Verb page](/business/nouns/suppression/list?interface=mcp).

```text
do: return await $.Suppression.list(input)
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `suppressions` | list of [Suppression](/business/nouns/suppression) | Yes | One page of Suppressions. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Suppression.list({ limit: 20 })"
  }
}
```