---
title: "Update an inbox"
method: PATCH
path: "/v1/inboxes/{inboxId}"
tags: ["Inboxes"]
---

# Update an inbox

`PATCH /v1/inboxes/{inboxId}`

## Request

- Base URL: `https://api.volanea.com`
- URL: `https://api.volanea.com/v1/inboxes/{inboxId}`
- Auth: HTTP bearer

`paused` stops both receiving (mail is dropped) and sending.

## Path parameters

- `inboxId` string, required

## Request body

- object
  - `displayName` string, nullable
  - `status` 'active' | 'paused'
  - `metadata` object, nullable
  - `securityMode` 'off' | 'tag' | 'hold'

## Response `200`

The updated inbox.

- Inbox
  - `inboxId` string, required
  - `address` string, email, required
  - `domain` string, required
  - `kind` 'shared' | 'custom', required: `shared`: on the platform's shared inbox domain, no DNS needed. `custom`: on a domain of your own.
  - `displayName` string, nullable: Used as the From name on mail sent from this inbox.
  - `status` 'active' | 'paused' | 'deleted', required
  - `securityMode` 'off' | 'tag' | 'hold': Scan received mail for attempts to manipulate an AI agent. `tag`: deliver now, label `security-review` if flagged. `hold`: withhold from the agent (no `email.received`, hidden from reads) until the scan clears it or a project key releases it.
  - `clientId` string, nullable: Your idempotency key from creation, if you passed one.
  - `metadata` object, nullable
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `401`: Missing or invalid API key.
- `404`: Not found.
- `422`: Request validation failed (code `validation_error`, 422).

---

[API](https://skmtc.dev/volanea/apis/volanea-api.md) · [All operations](https://skmtc.dev/volanea/apis/volanea-api/llms.txt) · [OpenAPI document](https://skmtc.dev/volanea/apis/volanea-api/revisions/9e187ae84fda?raw)