Перейти к содержанию

Массовое изменение статуса сообщений на выбранный статус

Запрос

Тип Метод
PUT /messages/action/bulk_read

Описание: при выполнении запроса будет изменен статус сообщений с идентификаторами из запроса на выбранный статус. Позволяет менять статус только на read или unread, если указан unread - то статус будет изменен соответственно, при любом другом значении статус будет проставлен в read.

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

PUT
http://127.0.0.1/cruddy/v2/messages/action/bulk_read

Тело запроса:

Параметр Тип Обязательность Описание
status string Required Статус на который необходимо поменять конкретное сообщение. Допустимые значения:
- read
- unread
user_id string Required Идентификатор пользователя для которого нужно поменять статус у сообщений
id Array<string> Required Массив идентификаторов сообщений
Пример тела запроса

{
  "status": "read",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "id": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Успешный ответ

Статус код: 200 – успешный ответ.

Формат: JSON.

Тело ответа:

Параметр Тип Описание
affected_messages_count number Количество затронутых сообщений
Пример ответа

{
  "affected_messages_count": 10
}

Другие возможные ответы

Код Ответ Описание
400 Bad Request Неверный тип параметра запроса, либо отсутствует обязательный параметр
500 Internal Server Error Другие ошибки при редактировании объекта

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}