Удалить цепочку сообщений из папки

POST /message-threads/{id}/remove-from-folders

Удаляет цепочку сообщений из папки.

Цепочки сообщений, удаленные из папки UNREAD, в интерфейсе отмечены как прочитанные.

Цепочки сообщений, удаленные из папки IMPORTANT, в интерфейсе не отмечены как важные.

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

curl -X POST 'https://tasks.yandex.ru/api/v1/message-threads/61ebc4f06643ea4a616c4b5d/remove-from-folders' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here' \
     -H 'Content-Type: application/json' \
     -d '{"folders":["UNREAD"]}'
import requests

url = "https://tasks.yandex.ru/api/v1/message-threads/61ebc4f06643ea4a616c4b5d/remove-from-folders"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here',
  'Content-Type': 'application/json'
}
payload = {
  "folders": [
    "UNREAD"
  ]
}
response = requests.post(url, headers=headers, json=payload)

print(response.text)
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://tasks.yandex.ru/api/v1/message-threads/61ebc4f06643ea4a616c4b5d/remove-from-folders',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here',
    'Content-Type': 'application/json'
  },
  'body': JSON.stringify({
    "folders": [
      "UNREAD"
    ]
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path-параметры

Параметр

Описание

id*

string

Идентификатор цепочки сообщений.

Заголовки

Заголовок

Описание

Authorization

API-токен для авторизации аккаунта. В качестве префикса добавьте OAuth.

Content-Type

Указывает формат данных (application/json) в передаваемом теле запроса.

Тело и параметры запроса

{
  "folders": [
    "UNREAD",
    "IMPORTANT"
  ]
}

Параметр

Описание

folders

array of strings

Папки, из которых надо удалить цепочку сообщений.

  • INBOX — Входящие.
  • OUTBOX — Отправленные.
  • AUTOMATIC_NOTIFICATION — Уведомления.
  • IMPORTANT — Важные.
  • UNREAD — Непрочитанные.

Можно указать несколько значений.

Ответ

Подробная информация о цепочке сообщений.

Пример ответа
{
  "items": [
    {
      "id": "643933af08583e0a19c2167e",
      "topic": {
        "EN": "Test bonus"
      },
      "interlocutors_inlined": true,
      "interlocutors": [
        {
          "id": "6c6e20dc86cca2ae787afcb2629de162",
          "role": "REQUESTER",
          "myself": true
        },
        {
          "id": "a1b0b42923c429daa2c764d7ccfc364d",
          "role": "USER"
        }
      ],
      "messages_inlined": true,
      "messages": [
        {
          "text": {
            "EN": "Thank you"
          },
          "from": {
            "id": "6c6e20dc86cca2ae787afcb2629de162",
            "role": "REQUESTER",
            "myself": true
          },
          "created": "2023-04-14T11:06:23.096"
        }
      ],
      "compose_details": {
        "recipients_select_type": "DIRECT",
        "recipients_ids": [
          "a1b0b42923c429daa2c764d7ccfc364d"
        ]
      },
      "meta": {},
      "folders": [
        "UNREAD",
        "IMPORTANT"
      ],
      "answerable": false,
      "created": "2023-04-14T11:06:23.096"
    }
  ],
  "has_more": true
}

Параметр

Описание

id

string

Идентификатор цепочки сообщений.

topic

object

Заголовок цепочки сообщений.

interlocutors_inlined

boolean

Доступ к сведениям об отправителе и адресатах.

  • true — сведения доступны в поле interlocutors.
  • false — сведения доступны по отдельному запросу.

interlocutors[]

array of objects

Сведения об отправителе и адресатах, отсортированные по идентификаторам. Полный список параметров приведен в таблице Сведения об отправителе и адресатах.

messages_inlined

boolean

Доступ к сообщениям цепочки:

  • true — сообщение доступно в поле messages.
  • false — сообщение доступно по отдельному запросу.

messages[]

array of objects

Сообщения в цепочке. Отсортированы по дате создания (сначала новые). Полный список параметров приведен в таблице Сообщения в цепочке.

compose_details

object

Для сообщений, отправленных вами: детали POST-запроса для создания сообщения. Полный список параметров приведен в таблице Детали POST-запроса.

answerable

boolean

Возможность ответить на сообщение:

  • true — исполнитель может ответить на сообщение.
  • false — исполнитель не может ответить на сообщение.

folders[]

array of strings

Папки, в которых находится цепочка:

  • INBOX — Входящие.
  • OUTBOX — Отправленные.
  • AUTOMATIC_NOTIFICATION — Уведомления.
  • IMPORTANT — Важные.
  • UNREAD — Непрочитанные.

created

string

Дата создания первого сообщения в цепочке.

Сведения об отправителе и адресатах ('interlocutors[]')

Параметр

Описание

id

string

Идентификатор отправителя или адресата.

role

string

Роль отправителя или адресата в Яндекс Заданиях:

  • USER — исполнитель.
  • REQUESTER — заказчик.
  • ADMINISTRATOR — администратор.
  • SYSTEM — для сообщений, отправленных автоматически.

myself

boolean

Маркер отправителя или адресата с вашим идентификатором. Если идентификатор принадлежит вам, указывается значение true.

Сообщения в цепочке ('messages[]')

Параметр

Описание

text

object

Текст сообщения.

from

string

Сведения об отправителе сообщения.

from.id

string

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

from.role

string

Роль отправителя в Яндекс Заданиях:

  • USER — исполнитель.
  • REQUESTER — заказчик.
  • ADMINISTRATOR — администратор.
  • SYSTEM — сообщение было отправлено автоматически.

from.myself

boolean

Маркер отправителя с вашим идентификатором. Если отправитель — это вы, указывается значение true.

created

string

Дата создания сообщения.

Детали POST-запроса ('compose_details')

Параметр

Описание

recipients_select_type

string

Способ указания адресатов:

  • DIRECT — указать идентификаторы исполнителей.
  • FILTER — отобрать исполнителей с помощью фильтра.
  • ALL — отправить сообщение всем исполнителям, которые хотя бы раз пытались выполнять ваши задания.

recipients_ids

object

Список идентификаторов исполнителей, которым будет отправлено сообщение.

recipients_filter

object

Фильтр для отбора адресатов.

Обязательный параметр