---
title: "Update a mailbox label"
method: PATCH
path: "/v1/mailboxes/{id}/labels/{labelId}"
tags: ["Mailboxes"]
---

# Update a mailbox label

`PATCH /v1/mailboxes/{id}/labels/{labelId}`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/mailboxes/{id}/labels/{labelId}`
- Auth: API key in header `x-api-key`

Updates the fields you name and keeps the rest.

## Path parameters

- `id` string, required
- `labelId` string, required

## Request body

- UpdateMailboxLabelPayload
  - `displayName` string, nullable
  - `color` 'billing' | 'domain' | 'agent' | 'routing' | 'important' | 'neutral', nullable

## Response `200`

MailboxLabel

- MailboxLabel
  - `id` string, required
  - `slug` string, required
  - `displayName` string, required
  - `color` 'billing' | 'domain' | 'agent' | 'routing' | 'important' | 'neutral', nullable, required
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `404`: ResourceNotFoundError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

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