PostMessagePatch (V3)

Предупреждение

После окончания переходного периода эта версия метода перестанет работать и будет возвращать ошибки. Используйте новую версию метода — PostMessagePatch (V4).

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

POST /V3/PostMessagePatch
Query Parameters:

  • operationId – идентификатор операции. Необязательный параметр, нерегистрочувствительный. Если вызов с указанным идентификатором операции завершился успехом, то и все последующие вызовы с тем же идентификатором операции так же завершатся успехом. Результат всех последующих вызовов будет равен результату первого успешного вызова.

Request Headers:
Request Body:

Тело запроса должно содержать отправляемое дополнение к сообщению, представленное структурой MessagePatchToPost.

Status Codes:

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

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

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

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

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

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

  • 409 Conflict – осуществляется попытка отправить дубликат сообщения, или запрещен прием документов от контрагентов согласно свойству Sociability в структуре Organization, или в сутки отправлено больше трех невалидных подписей для одной сущности.

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

Response Headers:

  • Retry-After – если в ответе содержится HTTP-заголовок Retry-After, то предыдущий вызов этого метода с таким же идентификатором операции еще не завершен. В этом случае следует повторить вызов через указанное в заголовке время (в секундах), чтобы убедиться, что операция завершилась без ошибок.

Response Body:

Тело ответа содержит отправленное дополнение, представленное структурой MessagePatch.

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

См. также

Инструкции:
Методы для работы с сообщением:

  • GetMessage (V5) — возвращает данные сообщения по указанному идентификатору

  • GetMessage (V6) — возвращает данные сообщения по указанному идентификатору

  • PostMessage (V3) — отправляет сообщение

  • PostMessagePatch (V3) — отправляет дополнение к сообщению

  • PostMessagePatch (V4) — отправляет дополнение к сообщению

  • TransformTemplateToMessage — создает из шаблона исходящее неотправленное сообщение