# Update an inbox (/docs/api-reference/inboxes/update-inbox)

Changes the name messages from the inbox are sent with. Its address never changes.

`PATCH https://api.coss.com/v1/inboxes/{inbox_id}`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Path parameters

- `inbox_id` (string, required): The inbox's id.

## Request body

- `display_name` (string | null, 1-64 characters): The name messages are sent with; `null` sends with the bare address.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.inboxes.update("inbox_01k7c8m4q2f3e9v6t5r1n0p8yz", {
  display_name: "Acme Help",
});
```

HTTP:

```sh
curl -X PATCH "https://api.coss.com/v1/inboxes/inbox_01k7c8m4q2f3e9v6t5r1n0p8yz" \
  -H "Authorization: Bearer $COSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "display_name": "Acme Help"
}'
```

## Response 200

The updated inbox.

- `object` ("inbox", required)
- `id` (string, required)
- `address` (string, required): The inbox's email address (`username@domain`).
- `username` (string, required)
- `domain` (string, required)
- `kind` ("managed" | "domain", required): `managed`: at the environment's own domain under coss.com's inbound domain (no DNS setup). `domain`: at one of the environment's receiving domains.
- `display_name` (string | null, required): The name messages from the inbox are sent with.
- `client_id` (string | null, required): Your own id for the inbox, e.g. your agent's or user's (unique per environment).
- `can_send` (boolean, required): Whether messages can be sent from the inbox. Inboxes at coss.com's inbound domain only receive in live environments: create the inbox at a receiving domain under one of your verified domains to send from it.
- `sandbox` (boolean, required): Whether it belongs to a sandbox environment.
- `created_at` (string, required, date-time)
- `updated_at` (string, required, date-time)

Example:

```json
{
  "object": "inbox",
  "id": "inbox_01k7c8m4q2f3e9v6t5r1n0p8yz",
  "address": "support-agent@k3j9x2m7qp4l.inbound.coss.com",
  "username": "support-agent",
  "domain": "k3j9x2m7qp4l.inbound.coss.com",
  "kind": "managed",
  "display_name": "Acme Support",
  "client_id": "agent-42",
  "can_send": true,
  "sandbox": true,
  "created_at": "2026-10-10T12:00:00.000Z",
  "updated_at": "2026-10-10T12:00:00.000Z"
}
```

## Errors

- `400`: The `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `404`: No inbox with this id exists in this environment. (`not_found`)
- `422`: The body failed validation (`validation_error`).
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).