Přejít na hlavní obsah
POST
Pošli zákazníkovi jeden e-mail s informací, že jsou jeho laboratorní výsledky připraveny. E-mail se odešle na email profilu objednávky domácí testovací sady. E-mail používá obecný partnerský branding: název a logo primární profilové skupiny profilu. Je v jazyce language profilu, výchozí je angličtina. Nastav with_reports na true, pokud chceš připojit laboratorní zprávy ze sady. E-mail obsahuje všechny zprávy, které zákazník vidí v aplikaci. Nastav ho na false, pokud chceš poslat jen upozornění. Přidej note, aby se v e-mailu zobrazila osobní poznámka, maximálně 1 000 znaků. Každá přiložená zpráva je PDF zašifrované pomocí AES-256. Heslem je date_of_birth z profilu jako 8 číslic ve formátu DDMMYYYY bez teček: zákazník narozený 1. února 1985 zadá 01021985. E-mail zákazníkovi tento formát sdělí, ale nikdy samotné datum narození. Každé volání odešle jeden e-mail. Volání se nededuplikují: když endpoint zavoláš dvakrát, zákazník dostane dva e-maily. E-mail se neodešle, když:
  • Zatím nedorazila žádná laboratorní zpráva.
  • Profil nemá e-mailovou adresu, nebo má jen zástupnou adresu @aniva.email.
  • Profil má vypnuté transakční e-maily. Pokud je chceš znovu zapnout, nastav transactional_emails_enabled na true přes Upravit profil.
  • with_reports je true a profil nemá date_of_birth. Nastav ho přes Upravit profil, nebo pošli požadavek s with_reports: false.
  • Objednávka je jedna z demo objednávek domácí testovací sady. Demo objednávka nemá zákazníka, kterému by se dal poslat e-mail.
Vyžaduje rozsah results_view a k tomu rozsah home_kit_orders_view nebo home_kit_orders_manage.

Požadavek

Parametry cesty

string
povinné
Jedinečný identifikátor (UUID) objednávky domácí testovací sady, jejíž výsledky chceš poslat e-mailem.

Parametry těla

boolean
povinné
true přiloží laboratorní zprávy jako PDF soubory chráněné heslem. false odešle jen oznámení, že jsou výsledky připravené.
string
Osobní poznámka, která se v e-mailu zobrazí pod oznámením. Maximálně 1 000 znaků.

Odpověď

Při úspěchu vrátí API 200 OK.
string
povinné
Adresa, na kterou se e-mail odeslal: email profilu.
integer
povinné
Počet přiložených laboratorních zpráv. 0, když je with_reports nastaveno na false.
string
povinné
Čas odeslání e-mailu jako okamžik v UTC (ISO 8601 s příponou Z).

Chybové odpovědi

Tělo chyby obsahuje error, srozumitelnou zprávu, a reason, stabilní kód. Chyby validace a chybějící scope results_view pole reason nemají.