Перейти до основного вмісту
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.