Папки

Изменить папку

Доступ для AI:

Переименовывает, переносит и меняет состав папки за один вызов. Меняется только то, что передано.

object_ids заменяет состав целиком, а не дополняет его. Чтобы добавить один объект, передайте её вместе с теми, что уже лежат в папке.

Объект, который положить не удалось, остальной состав не отменяет: он не попадёт в папку, а его идентификатор вернётся в ignored_object_ids.

PATCH
/v3/folders/{folder_id}

Параметры

folder_idчислообязательный

Папка, которую нужно изменить.

Тело запроса

nameстрока

Новое название, 1–255 символов. Не передано – остаётся прежним.

parent_folder_idчисло

Перенести папку внутрь другой. null – вынести в корень. Не передано – остаётся где была.

object_idsсписок чисел

Новый состав папки целиком. Пустой список очищает состав.

Ответ

idчисло

Идентификатор папки.

user_idчисло

Владелец папки.

nameстрока

Название папки.

created_atдата и время

Когда папка создана.

parent_folder_idчисломожет быть пустым

Папка-родитель. Пусто – папка лежит в корне.

objectsсписок объектов

Объекты, лежащие непосредственно в этой папке.

objects[].idчисло

Идентификатор объекта.

objects[].nameстрока

Название объекта.

subfoldersсписок объектов

Подпапки этой папки, по названию по алфавиту.

subfolders[].idчисло

Идентификатор подпапки.

subfolders[].user_idчисло

Владелец подпапки.

subfolders[].nameстрока

Название подпапки.

subfolders[].created_atдата и время

Когда подпапка создана.

subfolders[].parent_folder_idчисломожет быть пустым

Папка-родитель.

subfolders[].objectsсписок объектов

Объекты, лежащие непосредственно в подпапке.

subfolders[].objects[].idчисло

Идентификатор объекта.

subfolders[].objects[].nameстрока

Название объекта.

subfolders[].subfoldersсписок объектов

Всегда пусто: глубина ограничена двумя уровнями.

subfolders[].subfolders[].idчисло

Идентификатор папки.

subfolders[].subfolders[].user_idчисло

Владелец папки.

subfolders[].subfolders[].nameстрока

Название папки.

subfolders[].subfolders[].created_atдата и время

Момент создания папки (UTC, ISO 8601).

subfolders[].subfolders[].parent_folder_idчисломожет быть пустым

Родительская папка; null у папки верхнего уровня.

subfolders[].subfolders[].objectsсписок объектов

Собственный состав папки — объекты с названиями.

subfolders[].subfolders[].objects[].idчисло

Идентификатор объекта.

subfolders[].subfolders[].objects[].nameстрока

Название объекта.

subfolders[].subfolders[].subfoldersсписок объектов

Подпапки со своим составом.

subfolders[].subfolders[].subfolders[].idчисло

Идентификатор папки.

subfolders[].subfolders[].subfolders[].user_idчисло

Владелец папки.

subfolders[].subfolders[].subfolders[].nameстрока

Название папки.

subfolders[].subfolders[].subfolders[].created_atдата и время

Момент создания папки (UTC, ISO 8601).

subfolders[].subfolders[].subfolders[].parent_folder_idчисломожет быть пустым

Родительская папка; null у папки верхнего уровня.

subfolders[].subfolders[].subfolders[].objectsсписок объектов

Собственный состав папки — объекты с названиями.

subfolders[].subfolders[].subfolders[].subfoldersсписок объектов

Подпапки со своим составом.

ignored_object_idsсписок чисел

Идентификаторы из object_ids, которые в состав не попали: чужие, удалённые или несуществующие.

curl -X PATCH "https://example.com/v3/folders/0" \  -H "Content-Type: application/json" \  -d '{    "name": "Москва и область",    "object_ids": [      20,      21,      22,      99    ]  }'
{  "id": 12,  "user_id": 6,  "name": "Москва и область",  "created_at": "2026-07-28T16:50:24",  "parent_folder_id": null,  "objects": [    {      "id": 20,      "name": "Националь"    },    {      "id": 21,      "name": "Метрополь"    },    {      "id": 22,      "name": "Балчуг"    }  ],  "subfolders": [    {      "id": 13,      "user_id": 6,      "name": "Центр",      "created_at": "2026-07-28T16:52:11",      "parent_folder_id": 12,      "objects": [        {          "id": 22,          "name": "Балчуг"        }      ],      "subfolders": []    }  ],  "ignored_object_ids": [    99  ]}

Коды ошибок общие для всего API и описаны на странице Ошибки.