---
title: "Update Inbox"
method: PATCH
path: "/v0/pods/{pod_id}/inboxes/{inbox_id}"
tags: ["PodsInboxes"]
---

# Update Inbox

`PATCH /v0/pods/{pod_id}/inboxes/{inbox_id}`

**CLI:**
```bash
agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
```

## Path parameters

- `pod_id` string, required — ID of pod.
- `inbox_id` string, required — The ID of the inbox.

## Request body

- InboxesUpdateInboxRequest
  - `display_name` string — Display name: `Display Name <username@domain.com>`.
  - `metadata` InboxesUpdateMetadata — Custom key-value pairs to merge into the inbox's existing metadata. A value may be a string, number, boolean, or null. Setting a key to null removes it. Up to 256 keys; keys and string values are each limited to 256 characters.

## Response `200`

- InboxesInbox
  - `pod_id` string, required — ID of pod.
  - `inbox_id` string, required — The ID of the inbox.
  - `email` string, required — Email address of the inbox.
  - `display_name` string — Display name: `Display Name <username@domain.com>`.
  - `client_id` string — Client ID of inbox.
  - `metadata` InboxesMetadata — Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and string values are each limited to 256 characters. When updating metadata, send a key with a null value to remove that key.
  - `updated_at` string, date-time, required — Time at which inbox was last updated.
  - `created_at` string, date-time, required — Time at which inbox was created.

## Other responses

- `404`

---

[API](https://skmtc.net/agentmail-to/apis/api.md) · [All operations](https://skmtc.net/agentmail-to/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/agentmail-to/api/revisions/394ddcdd9c29/schema)