---
title: "Переименовать папку ящика"
method: PATCH
path: "/api/v1/mail/folders/{id}"
tags: ["Mail accounts"]
---

# Переименовать папку ящика

`PATCH /api/v1/mail/folders/{id}`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/mail/folders/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://erp.akeda.ru/oauth2/authorize`, token URL `https://erp.akeda.ru/oauth2/token`, scopes: `akeda:delegate`)

Системную папку переименовать нельзя — 409 mail.system_folder: без «Входящих» ящик перестаёт работать.

## Request body

- MailFolderInput: Создание и переименование пользовательской папки
  - `name` string, required: Косые черты запрещены: разделитель иерархии задаёт сервер
  - `parent_id` string, uuid

## Response `200`

Переименованная папка

- MailFolder: Папка ящика. Координаты синхронизации IMAP (UIDVALIDITY, UIDNEXT, последний прочитанный UID) наружу не отдаются.
  - `id` string, uuid, required
  - `account_id` string, uuid, required
  - `external_id` string, required: Идентификатор папки у провайдера; локальная папка «Исходящие» использует внутренний идентификатор и не синхронизируется по IMAP
  - `name` string, required
  - `role` 'inbox' | 'outbox' | 'sent' | 'drafts' | 'trash' | 'spam' | 'archive' | 'custom', required: Назначение папки в нашем прочтении, а не её имя на сервере. Незнакомое имя остаётся custom — угаданная роль складывала бы туда отправленные письма.
  - `parent_id` string, uuid, required
  - `delimiter` string, required: Разделитель иерархии, который назвал сервер
  - `total_count` integer, required
  - `unread_count` integer, required
  - `sort_order` integer, required: Вес папки в привычном порядке системных папок
  - `subscribed` boolean, required
  - `mirror` boolean, required: Вид на ту же почту (Gmail «Вся почта», «Важное», «Помеченные»): письма в нём — копии писем из настоящих папок, в сводные выборки они не попадают
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `400`: Некорректный запрос или нарушение бизнес-правила
- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права
- `404`: Запись не найдена или не видима текущему пользователю
- `409`: Конфликт версии, идемпотентности или бизнес-состояния

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/3c60ded179f2?raw)