---
title: "Update an inbox"
method: PATCH
path: "/v1/inboxes/{id}"
tags: ["Inboxes"]
---

# Update an inbox

`PATCH /v1/inboxes/{id}`

## Request

- Base URL: `https://api.agentboxd.com`
- URL: `https://api.agentboxd.com/v1/inboxes/{id}`
- Auth: HTTP bearer

`{ display_name?, metadata?, ttl_seconds?, promotions_filter? }`. Metadata is merged; a `null` value deletes the key. See [Metadata](https://agentboxd.com/docs/metadata). `ttl_seconds` extends a temporary inbox, counted from now, up to 24 hours after it was created. `promotions_filter` turns the [Promotions & spam view](https://agentboxd.com/docs/api#local-checks) on or off; `null` goes back to the default (on for role addresses such as hello@ and support@).

Permission: `inboxes:write`.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `display_name` string, nullable
  - `metadata` object
  - `ttl_seconds` integer
  - `promotions_filter` boolean, nullable

## Response `200`

OK

- object

## Other responses

- `4XX`: Error
- `5XX`: Error

---

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