Restore

Метод Restore восстанавливает документ из удаленных.

POST /Restore
Query Parameters:

  • boxId – идентификатор ящика организации.

  • messageId – идентификатор сообщения.

  • documentId – идентификатор документа в сообщении. Необязательный параметр.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – не найдено сообщение или документ с указанными идентификаторами.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 409 Conflict – осуществляется попытка повторного восстановления документа или сообщения.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Метод может восстанавливать не только сообщения Message, но и шаблоны Template. Для этого в качестве параметра messageId нужно передать идентификатор сообщения шаблона.

Если параметр documentId не задан, то будет восстановлено сообщение messageId. В этом случае со всех документов в нем будет снята пометка об удалении. Если в удаленном сообщении восстановлен хотя бы один документ, то со всего сообщения или шаблона будет снята пометка об удалении.

Для выполнения метода текущий пользователь должен иметь доступ ко всем восстанавливаемым документам, иначе метод вернет ошибку 403 (Forbidden).