---
title: "Update mailbox"
method: PATCH
path: "/api/emails/{address}"
tags: ["Email"]
---

# Update mailbox

`PATCH /api/emails/{address}`

## Request

- Base URL: `https://domani.run`
- URL: `https://domani.run/api/emails/{address}`
- Auth: HTTP bearer

Update a mailbox's display name, webhook URL, or forward-to email address by its full email address. Set to null to disable/clear.

## Path parameters

- `address` string, required

## Request body

- object
  - `name` string, nullable: Display name for the mailbox. Set to null to clear.
  - `webhook_url` string, nullable: HTTPS URL for inbound email webhook, or null to clear
  - `forward_to` string, nullable: Email address to forward inbound emails to, or null to clear
  - `drop_spam` boolean: Drop (don't store or webhook) inbound messages flagged as spam
  - `tone_notes` string, nullable: Voice hints agents read before drafting from this mailbox (tone, signature, phrasing dos and don'ts). Set to null to clear.

## Response `200`

Mailbox updated

- object
  - `id` string
  - `address` string
  - `slug` string
  - `domain` string
  - `name` string, nullable
  - `webhook_url` string, nullable
  - `forward_to` string, nullable
  - `tone_notes` string, nullable
  - `signing_secret` string: HMAC secret for verifying inbound webhook payloads

---

[API](https://skmtc.dev/domani/apis/domani-run-api.md) · [All operations](https://skmtc.dev/domani/apis/domani-run-api/llms.txt) · [OpenAPI document](https://skmtc.dev/domani/apis/domani-run-api/revisions/7679f8159533?raw)
