---
title: "Update a label"
method: PATCH
path: "/inbox/labels/{label_id}/"
tags: ["inbox"]
---

# Update a label

`PATCH /inbox/labels/{label_id}/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/inbox/labels/{label_id}/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Rename (seeded labels refuse, because the classifier and the positive rate resolve them by name) and/or set whether the label's threads count into the positive rate.

## Path parameters

- `label_id` string, uuid, required

## Request body

- LabelUpdateSchema: Partial update of a label. `name` renames (seeded labels refuse, because their name is a contract); `track_as_positives` opts the label's threads in or out of the positive rate; `filtered_out` moves them out of (or back into) the working views. All allowed on any label.
  - `filtered_out` boolean, nullable
  - `name` string, nullable
  - `track_as_positives` boolean, nullable

## Response `200`

Successful Response

- LabelReadSchema
  - `color` string, required
  - `filtered_out` boolean
  - `icon` string
  - `id` string, uuid, required
  - `is_seeded` boolean
  - `name` string, required
  - `thread_count` integer, required
  - `track_as_positives` boolean

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found.
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)