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

# Update an inbox

`PATCH /inboxes/{inboxId}`

## Request

- Base URL: `https://api.superchat.com/v1.0`
- URL: `https://api.superchat.com/v1.0/inboxes/{inboxId}`
- Auth: API key in header `X-API-KEY`

Updates the basics of an inbox.

## Path parameters

- `inboxId` string, required

## Request body

- PAUpdateInboxDTO
  - `name` string, required: The updated name of the inbox
  - `emoji` string, nullable: The updated emoji of the inbox
  - `description` string, nullable: The updated description of the inbox
  - `timezone` string, nullable: The updated timezone of the inbox

## Response `200`

OK

- PAInboxWithUsers
  - `id` string, required: The ID of the inbox
  - `name` string, required: The name of the inbox
  - `emoji` string, nullable: The emoji of the inbox
  - `description` string, nullable: The description of the inbox
  - `timezone` string, required: The timezone of the inbox
  - `users` PAInboxUserDTO[], required: The users that belong to the inbox
    - `id` string, required: The ID of the inbox user
    - `email` string, required: The email address of the inbox user
    - `url` string: The URL of the user resource
  - `url` string: The URL of the inbox resource

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2026-11-03** `31e7bd6f37e9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/superchat/apis/superchat-api/changes/inboxes/:inboxId/patch.md)

---

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