---
title: "Edit inbox names"
method: PATCH
path: "/v1/inboxes/{inbox_id}"
tags: ["inboxes"]
---

# Edit inbox names

`PATCH /v1/inboxes/{inbox_id}`

## Request

- Base URL: `https://cherami.to`
- URL: `https://cherami.to/v1/inboxes/{inbox_id}`
- Auth: HTTP bearer

Changes `name`, `sender_name` or both. An omitted field stays as it is; `null` or a blank string clears it. The address can't be changed.

A new `sender_name` applies to mail sent afterwards.

## Path parameters

- `inbox_id` string, required

## Request body

- UpdateInbox
  - `name` string, nullable: Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.
  - `sender_name` string, nullable: Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.

## Response `200`

Success.

- Inbox
  - `id` string, required: Cherami resource ID.
  - `local_part` string, required
  - `address` string, required
  - `name` string, nullable, required
  - `sender_name` string, nullable, required
  - `created_at` string, date-time, required: UTC timestamp with milliseconds.

## Other responses

- `400`: `invalid_json`: Send a valid UTF-8 JSON object, not an array or scalar. `invalid_inbox`: Creation takes only `local_part`, `name`, `sender_name` and `idempotency_key`; an edit takes at least one of `name` and `sender_name`, and nothing else. `invalid_name`: Use plain text without control characters, at most 256 UTF-8 bytes after trimming. The message names the field.
- `401`: `unauthorized`: Send a valid API key as `Authorization: Bearer <key>`. If the key stopped working, get a new one through [recovery](https://cherami.to/docs/guides/recovery).
- `404`: `not_found`: The resource does not exist or does not belong to this account. A reply or forward source must also be in the sending inbox.
- `413`: `body_too_large`: Reduce the JSON request to the operation's body limit.
- `415`: `unsupported_media_type`: Send `Content-Type: application/json`.
- `500`: `internal_error`: The operation failed. Retry a read; after a write the change may have happened, so recover as [retry by operation](https://cherami.to/docs/api/errors#retry-by-operation) describes.

---

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