метод REST scope: mail

mail.message.movetofolder

Переместить письма в папку

Кто может выполнять: пользователь с доступом к почтовому ящику, где находятся письма

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод mail.message.movetofolder перемещает письма в папку, спам или корзину.

Параметры

messageIds array обязательный

Массив идентификаторов писем.

Идентификаторы можно получить методом mail.message.list.

Передавайте в одном запросе письма только из одной папки и одного почтового ящика

action string обязательный

Действие для писем:

  • move — переместить в папку, указанную в folder
  • spam — переместить в спам
  • delete — переместить в корзину
folder string необязательный

Имя или путь существующей папки в этом почтовом ящике.

Обязательно для действия move

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"messageIds":[15,16],"action":"spam"}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.message.movetofolder

Ответ

HTTP-статус: 200

{
    "result": {
        "success": true,
        "movedCount": 2,
        "action": "spam"
    },
    "time": {
        "start": 1779819678,
        "finish": 1779819678.84803,
        "duration": 0.8480300903320312,
        "processing": 0,
        "date_start": "2026-05-26T21:21:18+03:00",
        "date_finish": "2026-05-26T21:21:18+03:00",
        "operating_reset_at": 1779820278,
        "operating": 0
    }
}

Возвращаемые данные

result object

Объект с результатом перемещения

success boolean

Признак успешного выполнения операции

movedCount integer

Количество обработанных писем

action string

Выполненное действие

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Обязательное поле не указано",
                "field": "messageIds"
            }
        ]
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
messageIds Обязательное поле не указано Передайте messageIds в теле запроса
messageIds Выберите письма из одной папки Передавайте в одном запросе письма только из одной папки
folder Параметр folder обязателен при action=move Передайте folder или используйте action=spam / action=delete
action Параметр action должен быть move, spam или delete Передайте одно из допустимых значений
messageIds No accessible messages found Передайте существующие идентификаторы писем, к которым у пользователя есть доступ
messageIds All messages must belong to the same mailbox Передавайте в запросе письма только из одного почтового ящика

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.