Перейти к основному содержанию
POST
Отправь клиенту одно письмо о том, что лабораторные результаты готовы. Письмо отправляется на email профиля из заказа набора для домашнего теста. В письме используется общий брендинг партнёра: название и логотип основной группы профилей этого профиля. Язык письма — language профиля, по умолчанию английский. Установи для with_reports значение true, чтобы прикрепить лабораторные отчёты по набору. К письму прикрепляется каждый отчёт, который клиент видит в приложении. Установи false, чтобы отправить только уведомление. Добавь note, чтобы показать в письме личную заметку, не более 1 000 символов. Каждый прикреплённый отчёт — это PDF-файл, зашифрованный с помощью AES-256. Пароль — поле date_of_birth профиля в виде 8 цифр, DDMMYYYY, без точек: клиент, родившийся 1 февраля 1985 года, вводит 01021985. В письме клиенту сообщается этот формат, но никогда не указывается сама дата рождения. Каждый вызов отправляет одно письмо. Вызовы не дедуплицируются: если ты вызовешь эндпоинт дважды, клиент получит два письма. Письмо не отправляется, если:
  • Лабораторный отчёт ещё не поступил.
  • В профиле нет адреса электронной почты или указан только адрес-заглушка @aniva.email.
  • В профиле отключены транзакционные письма. Чтобы снова их включить, установи для transactional_emails_enabled значение true через Обновить профиль.
  • with_reports имеет значение true, а в профиле нет date_of_birth. Задай это значение через Обновить профиль или отправь запрос с with_reports: false.
  • Это один из демозаказов набора для домашнего теста. У демозаказа нет клиента, которому можно отправить письмо.
Требуется разрешение results_view, а также разрешение home_kit_orders_view или home_kit_orders_manage.

Запрос

Параметры пути

string
обязательно
Уникальный идентификатор (UUID) заказа набора для домашнего теста, результаты которого нужно отправить по почте.

Параметры тела запроса

boolean
обязательно
true прикрепляет лабораторные отчёты в виде PDF-файлов, защищённых паролем. false отправляет только уведомление о готовности результатов.
string
Личная заметка, которая отображается в письме под уведомлением. Не более 1 000 символов.

Ответ

При успехе API возвращает 200 OK.
string
обязательно
Адрес, на который ушло письмо: поле email профиля.
integer
обязательно
Количество прикреплённых лабораторных отчётов. 0, если with_reports имеет значение false.
string
обязательно
Время отправки письма в UTC (ISO 8601 с суффиксом Z).

Ответы с ошибками

Тело ошибки содержит error (понятное человеку сообщение) и reason (стабильный код). У ошибок валидации и при отсутствии права доступа results_view поле reason отсутствует.