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

# Update an inbox

`PATCH /inboxes/{id}`

## Request

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

Required scope: `inbox:write`. (`inbox:*` scopes cannot be assigned from the UI: they require a full-access `*` key).

## Path parameters

- `id` string, required: Inbox ID.

## Request body

- InboxPatch
  - `displayName` string
  - `status` 'active' | 'archived'

## Response `200`

Inbox updated.

- InboxEnvelope
  - `inbox` Inbox, required
    - `id` string, uuid, required
    - `localPart` string
    - `address` string
    - `displayName` string
    - `status` string
    - `createdAt` string, date-time

## Other responses

- `401`: Missing or invalid token.
- `403`: Insufficient scope.
- `404`: Resource not found.
- `422`: Invalid input.

---

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