Afspraken
Resultaten mailen
Mail de klant dat de labresultaten klaarstaan
POST
/
api
/
v1
/
appointments
/
{id}
/
results
/
email
curl --request POST \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}
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_enabledoptruemet Profiel bijwerken. with_reportstrueis en het profiel geendate_of_birthheeft. Stel die in met Profiel bijwerken, of verstuur metwith_reports: false.
results_view.
Verzoek
Padparameters
Bodyparameters
true voegt de labrapporten toe als met een wachtwoord beveiligde pdf-bestanden. false stuurt alleen de melding dat de resultaten
klaarstaan.Respons
Bij succes retourneert de API200 OK.
Foutresponsen
Een foutbody bevaterror, een leesbare melding, en reason, een vaste code. Validatiefouten
en een ontbrekende scope results_view hebben geen reason.
| Status | Reden | Beschrijving |
|---|---|---|
400 | — | Validatiefout — ongeldige ID, ontbrekende with_reports, of note is langer dan 1.000 tekens. |
403 | access_denied | Geen toegang — je API-sleutel heeft de scope niet, of de afspraak valt buiten je toegangscontext. |
404 | not_found | Afspraak niet gevonden. |
409 | no_reports | Er is nog geen labrapport binnengekomen. |
409 | no_email | Het profiel heeft geen e-mailadres. |
409 | placeholder_email | Het profiel heeft alleen een plaatsvervangend @aniva.email-adres. Werk het profiel bij met een echt e-mailadres. |
409 | unsubscribed | Het profiel heeft transactionele e-mails uitgeschakeld. Zet eerst transactional_emails_enabled op true. |
409 | no_birthdate | with_reports is true en het profiel heeft geen date_of_birth, het pdf-wachtwoord. |
413 | reports_too_large | De rapporten zijn te groot voor één e-mail. Verstuur de e-mail met with_reports: false. |
422 | report_unprotectable | Een rapport is geen pdf of kon niet met een wachtwoord worden beveiligd. Verstuur met with_reports: false. |
500 | — | Interne serverfout. |
502 | report_unavailable | Een labrapport kon niet worden geladen. Er is geen e-mail verstuurd. |
502 | send_failed | De e-mailprovider heeft de e-mail geweigerd. Er is geen e-mail verstuurd. |
curl --request POST \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}