# rest

URL: /business/nouns/mailbox/rest · Id: `verb:Mailbox.rest` · Call: `await $.Mailbox.rest({ … })` (SDK) or the `do` tool at `https://api.sb/mcp`. Inputs says what to pass, Outputs what returns, When it waits who approves.

> Rest pauses a Mailbox’s sending when a brake fires and resumes it when the reading clears.

Rest pauses a [Mailbox](/business/nouns/mailbox)’s sending when a brake fires and resumes it when the reading clears.

## Inputs
| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `mailbox` | [Mailbox](/business/nouns/mailbox) | Yes | The Mailbox to pause. |
| `reason` | `string` | Yes | The brake that fired. |

## Outputs
| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `mailbox` | [Mailbox](/business/nouns/mailbox) | Yes | The Mailbox, resting. |

## Effects
- Emits [`Mailbox.rested`](/business/events/Mailbox.rested).
- Performed by the [Customer Lead](/agents/customer/customer-lead).
- Two-way: it runs at once, in the `try`, `send` and `do` modes.
- Fires on its own above 0.1 percent complaints or 2 percent bounces; a brake never waits.
- A blocklisted Domain also opens an Incident.

## 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. | [Mailbox.rest](/business/nouns/mailbox/rest) |

## When it waits
| Gate | Default |
| --- | --- |
| Decision class | Low: two-way, nothing at stake |
| [Delay window](/systems/trust-and-governance/controls/one-way-windows) | None: it runs once review passes. |
| Limit | The call [Limit](/business/nouns/limit) of the [Permission](/business/nouns/permission) it runs under. |
| Over the Limit | It waits `pending` for an [Approval](/business/nouns/approval) from the [Founder](/agents/founding/founder). Approved, it runs; refused, it ends `refused` with [`limit-exceeded`](/code/api/errors/limit-exceeded); unanswered by its deadline, it ends `canceled`. |

## Example

**Ask**

```text
Rest my mailbox.
```

**API**

```bash
curl -X POST https://api.sb/kilnbakery.com/mailboxes/mailbox_1/rest \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"complaints"}'
```

```json
{
  "api": "https://api.sb/kilnbakery.com",
  "mailbox": {
    "$id": "https://api.sb/kilnbakery.com/mailboxes/mailbox_1",
    "$type": "Mailbox",
    "medium": "email",
    "address": "tomas@kilnbakery.com",
    "stream": "transactional"
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/action_1",
    "operation": "Mailbox.rest",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/action_1"
  }
}
```

**SDK**

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

const mailbox = await $.Mailbox.rest({ mailbox: 'mailbox_1', reason: 'complaints' })
```

**CLI**

```bash
npx startup-builder do Mailbox.rest --json '{"mailbox":"mailbox_1","reason":"complaints"}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Mailbox.rest({ mailbox: 'mailbox_1', reason: 'complaints' })"
  }
}
```