Salt la conținutul principal
POST
Trimite clientului un e-mail care îl anunță că rezultatele de laborator sunt gata. E-mailul este trimis la adresa email a profilului comenzii de kit de testare la domiciliu. E-mailul folosește brandingul generic al partenerului: numele și logo-ul grupului principal de profiluri al profilului. Este în limba language a profilului, implicit engleză. Setează with_reports la true pentru a atașa rapoartele de laborator ale kitului. E-mailul atașează fiecare raport pe care clientul îl poate vedea în aplicație. Setează-l la false pentru a trimite doar notificarea. Adaugă note pentru a afișa o notă personală în e-mail, de cel mult 1.000 de caractere. Fiecare raport atașat este un PDF criptat cu AES-256. Parola este date_of_birth din profil sub formă de 8 cifre, DDMMYYYY, fără puncte: un client născut pe 1 februarie 1985 tastează 01021985. E-mailul îi comunică clientului acest format, dar niciodată data nașterii în sine. Fiecare apel trimite un e-mail. Apelurile nu sunt deduplicate: dacă apelezi endpointul de două ori, clientul primește două e-mailuri. E-mailul nu se trimite când:
  • Nu a sosit încă niciun raport de laborator.
  • Profilul nu are adresă de e-mail sau are doar o adresă provizorie @aniva.email.
  • Profilul a dezactivat e-mailurile tranzacționale. Pentru a le reactiva, setează transactional_emails_enabled la true cu Actualizare profil.
  • with_reports este true, iar profilul nu are date_of_birth. Seteaz-o cu Actualizare profil sau trimite cu with_reports: false.
  • Comanda este una dintre comenzile demo de kituri de testare la domiciliu. O comandă demo nu are un client căruia să îi trimiți e-mail.
Necesită scope-ul results_view, plus scope-ul home_kit_orders_view sau home_kit_orders_manage.

Cerere

Parametri de cale

string
obligatoriu
Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu pentru care trimiți rezultatele prin e-mail.

Parametri de corp

boolean
obligatoriu
true atașează rapoartele de laborator ca fișiere PDF protejate cu parolă. false trimite doar notificarea că rezultatele sunt gata.
string
O notă personală pe care e-mailul o afișează sub notificare. Cel mult 1.000 de caractere.

Răspuns

La succes, API-ul returnează 200 OK.
string
obligatoriu
Adresa la care a fost trimis e-mailul: adresa email a profilului.
integer
obligatoriu
Numărul de rapoarte de laborator atașate. 0 când with_reports este false.
string
obligatoriu
Momentul în care a fost trimis e-mailul, în format UTC (ISO 8601 cu sufixul Z).

Răspunsuri de eroare

Corpul unei erori conține error, un mesaj lizibil, și reason, un cod stabil. Erorile de validare și lipsa permisiunii results_view nu au reason.