---
search:
  tags:
    - Inboxes
    - PATCH
seo:
  description: >-
    Its name or from_name; BillionSend extension: expires_in, a new lifetime
    counted… Reference for the PATCH /inboxes/{inbox_id} endpoint in the
    BillionSend API.
sidebar:
  label: Update an inbox
  badge: PATCH
title: Update an inbox
type: openapi-operation
---
Its name or from_name; BillionSend extension: expires_in, a new lifetime counted from now. On a shared-domain inbox a new from_name is reviewed first (503 while that review is unavailable). Returns the full inbox.

`PATCH /inboxes/{inbox_id}`

**Request body** (`application/json`)

- `name` (string)
- `from_name` (string) — "" removes it. On the shared domain a new one may not imitate a brand, and it is reviewed first where the instance reviews names (503 with retry-after while that review is unavailable).
- `expires_in` (string | null) — BillionSend extension: a new lifetime counted from now, "1h" to "365d"; null never expires

Request body example:

```json
{
  "name": "string",
  "from_name": "string",
  "expires_in": "string"
}
```

**Responses**

- `200` — Inbox updated
- `401` — Missing, malformed, unknown or revoked API key
- `404` — Not found
- `422` — Validation error
- `429` — Too many names reviewed or refused on the shared domain today, or the rate limit (rate\_limit\_exceeded, with Retry-After)
- `503` — A new from\_name on the shared domain can't be reviewed right now; retry-after says when to try again

Response example, 200:

```json
{
  "object": "inbox",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "email_address": "string",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "receiving_address": "string",
  "from_name": "string",
  "unread": 0,
  "drafts": 0,
  "last_received": "string",
  "created_at": "string",
  "updated_at": "string",
  "kind": "agent",
  "shared": true,
  "expires_at": "string",
  "quarantined": 0,
  "pending_approval": 0
}
```
