---
title: "Update Mailbox"
method: PATCH
path: "/api/v1/mailboxes/{mailbox_id}"
tags: ["mailboxes"]
---

# Update Mailbox

`PATCH /api/v1/mailboxes/{mailbox_id}`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/mailboxes/{mailbox_id}`
- Auth: HTTP bearer

## Path parameters

- `mailbox_id` string, uuid, required

## Request body

- MailboxPatch: Omit a field to leave it; ``paired_seat_id: null`` unpairs.
  - `paired_seat_id` string, uuid, nullable
  - `daily_cap` integer, nullable

## Response `200`

Successful Response

- MailboxOut
  - `id` string, uuid, required
  - `provider` string, required
  - `address` string, required
  - `display_name` string, nullable, required
  - `status` string, required
  - `paired_seat_id` string, uuid, nullable, required
  - `daily_cap` integer, required
  - `cap_today` integer, required
  - `created_at` string, date-time, required
  - `last_error` string, nullable

## Other responses

- `422`: Validation Error

---

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