Przejdź do głównej treści
POST
Wyślij klientowi jednego e-maila z informacją, że wyniki laboratoryjne są gotowe. Wiadomość trafia na email z profilu zamówienia domowego zestawu testowego. E-mail korzysta z ogólnego brandingu partnera: nazwy i logo głównej grupy profili tego profilu. Jest w języku language profilu, domyślnie po angielsku. Ustaw with_reports na true, aby załączyć raporty laboratoryjne zestawu. W e-mailu załączony jest każdy raport, który klient widzi w aplikacji. Ustaw false, aby wysłać tylko powiadomienie. Dodaj note, aby wyświetlić w e-mailu osobistą notatkę, maksymalnie 1 000 znaków. Każdy załączony raport to plik PDF zaszyfrowany algorytmem AES-256. Hasłem jest pole date_of_birth profilu jako 8 cyfr, DDMMYYYY, bez kropek: klient urodzony 1 lutego 1985 wpisuje 01021985. E-mail podaje klientowi ten format, ale nigdy samej daty urodzenia. Każde wywołanie wysyła jeden e-mail. Wywołania nie są deduplikowane: jeśli wywołasz endpoint dwa razy, klient dostanie dwa e-maile. E-mail nie jest wysyłany, gdy:
  • Żaden raport laboratoryjny jeszcze nie dotarł.
  • Profil nie ma adresu e-mail lub ma tylko zastępczy adres @aniva.email.
  • W profilu wyłączono e-maile transakcyjne. Aby włączyć je ponownie, ustaw transactional_emails_enabled na true za pomocą Zaktualizuj profil.
  • with_reports ma wartość true, a profil nie ma pola date_of_birth. Ustaw je za pomocą Zaktualizuj profil lub wyślij z with_reports: false.
  • Zamówienie jest jednym z demonstracyjnych zamówień domowego zestawu testowego. Zamówienie demonstracyjne nie ma klienta, do którego można wysłać e-mail.
Wymaga zakresu results_view oraz zakresu home_kit_orders_view lub home_kit_orders_manage.

Żądanie

Parametry ścieżki

string
wymagane
Unikalny identyfikator (UUID) zamówienia domowego zestawu testowego, którego wyniki chcesz wysłać e-mailem.

Parametry treści

boolean
wymagane
true dołącza raporty laboratoryjne jako pliki PDF chronione hasłem. false wysyła tylko powiadomienie, że wyniki są gotowe.
string
Osobista wiadomość wyświetlana w e-mailu pod powiadomieniem. Maksymalnie 1 000 znaków.

Odpowiedź

W razie powodzenia API zwraca 200 OK.
string
wymagane
Adres, na który wysłano e-mail: pole email profilu.
integer
wymagane
Liczba załączonych raportów laboratoryjnych. 0, gdy with_reports ma wartość false.
string
wymagane
Czas wysłania e-maila jako znacznik UTC (ISO 8601 z sufiksem Z).

Odpowiedzi z błędami

Treść błędu zawiera pole error z czytelnym komunikatem oraz reason ze stałym kodem. Błędy walidacji i brak zakresu results_view nie mają pola reason.