Naar hoofdinhoud gaan
POST
Stuur de klant één e-mail waarin staat dat de labresultaten klaarstaan. De e-mail gaat naar het email-adres van het profiel van de thuistestkitbestelling. De e-mail gebruikt algemene partnerbranding: de naam en het logo van de primaire profielgroep van het profiel. Deze is in de language van het profiel, standaard Engels. Zet with_reports op true om de labrapporten van de kit bij te voegen. De e-mail stuurt elk rapport mee dat de klant in de app kan zien. Zet de waarde op false om alleen de melding te sturen. Voeg note toe om een persoonlijke notitie in de e-mail te tonen, maximaal 1.000 tekens. Elk bijgevoegd rapport is een pdf versleuteld met AES-256. Het wachtwoord is de date_of_birth van het profiel als 8 cijfers, DDMMYYYY, zonder punten: een klant geboren op 1 februari 1985 typt 01021985. De e-mail vermeldt dit formaat voor de klant, maar nooit de geboortedatum zelf. Elke aanroep verstuurt één e-mail. Aanroepen worden niet ontdubbeld: als je het endpoint twee keer aanroept, krijgt de klant twee e-mails. De e-mail wordt niet verstuurd als:
  • Er is nog geen labrapport binnengekomen.
  • Het profiel heeft geen e-mailadres, of alleen een plaatsvervangend @aniva.email-adres.
  • Het profiel heeft transactionele e-mails uitgeschakeld. Om ze weer aan te zetten, zet je transactional_emails_enabled op true met Profiel bijwerken.
  • with_reports is true en het profiel heeft geen date_of_birth. Stel deze in met Profiel bijwerken, of verstuur met with_reports: false.
  • De bestelling is een van de demo-thuistestkitbestellingen. Een demobestelling heeft geen klant om te e-mailen.
Vereist de scope results_view plus de scope home_kit_orders_view of home_kit_orders_manage.

Verzoek

Padparameters

string
vereist
Unieke identifier (UUID) van de thuistestkitbestelling waarvan je de resultaten wilt e-mailen.

Bodyparameters

boolean
vereist
true voegt de labrapporten toe als met een wachtwoord beveiligde pdf-bestanden. false stuurt alleen de melding dat de resultaten klaarstaan.
string
Een persoonlijk bericht dat de e-mail onder de melding toont. Maximaal 1.000 tekens.

Respons

Bij succes retourneert de API 200 OK.
string
vereist
Het adres waar de e-mail naartoe is gegaan: de email van het profiel.
integer
vereist
Het aantal bijgevoegde labrapporten. 0 als with_reports false is.
string
vereist
Wanneer de e-mail is verstuurd, als UTC-tijdstip (ISO 8601 met Z-achtervoegsel).

Foutresponsen

Een foutbody bevat error, een leesbare melding, en reason, een vaste code. Validatiefouten en een ontbrekende scope results_view hebben geen reason.