---
title: "PATCH /inboxes/{id}"
method: PATCH
path: "/inboxes/{id}"
---

# PATCH /inboxes/{id}

`PATCH /inboxes/{id}`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/inboxes/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Path parameters

- `id` string, required: Unique inbox identifier

## Request body

- object: Request body for updating an existing inbox
  - `displayName` string, nullable: Updated human-readable display name (set to null to clear)
  - `agentId` string: Move the inbox to a different agent. Not nullable: an inbox belongs to exactly one agent, so there is no unlinked state to set it to. Fails with 409 if the target agent already has an inbox.

## Response `200`

OK

- object: Inbox resource representation
  - `id` string, required: Unique identifier of the inbox
  - `email` string, email, required: Full email address of the inbox
  - `domain` string, required: Domain portion of the inbox email address
  - `localPart` string, required: Local part (before the @) of the inbox email address
  - `displayName` string, nullable, required: Human-readable display name, or null if not set
  - `agentId` string, required: ID of the agent this inbox belongs to
  - `createdAt` string, date-time, required: Timestamp when the inbox was created

## Other responses

- `403`: 403
- `404`: 404
- `409`: 409

---

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