Naar hoofdinhoud gaan
POST
Stuur de klant één e-mail met de melding dat de labresultaten klaarstaan. De e-mail gaat naar de email van het profiel van de afspraak. 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 afspraak als bijlage mee te sturen. De e-mail voegt elk rapport toe dat de klant in de app kan zien. Zet deze op false om alleen de melding te sturen. Voeg note toe om een persoonlijk bericht 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 nog geen labrapport is binnengekomen.
  • Het profiel geen e-mailadres heeft, of alleen een plaatsvervangend @aniva.email-adres.
  • Het profiel transactionele e-mails heeft uitgeschakeld. Om ze weer in te schakelen, zet je transactional_emails_enabled op true met Profiel bijwerken.
  • with_reports true is en het profiel geen date_of_birth heeft. Stel die in met Profiel bijwerken, of verstuur met with_reports: false.
Vereist de scope results_view.

Verzoek

Padparameters

string
vereist
Unieke identifier (UUID) van de afspraak 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.