Thuistestkitbestellingen
Resultaten mailen
De klant e-mailen dat de labresultaten van de thuistestkit klaarstaan
POST
/
api
/
v1
/
home-kit-orders
/
{id}
/
results
/
email
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}
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_enabledoptruemet Profiel bijwerken. with_reportsistrueen het profiel heeft geendate_of_birth. Stel deze in met Profiel bijwerken, of verstuur metwith_reports: false.- De bestelling is een van de demo-thuistestkitbestellingen. Een demobestelling heeft geen klant om te e-mailen.
results_view plus de scope home_kit_orders_view of home_kit_orders_manage.
Verzoek
Padparameters
Unieke identifier (UUID) van de thuistestkitbestelling waarvan je de resultaten wilt e-mailen.
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 | Verboden — je API-sleutel heeft de scopes niet, of de thuistestkitbestelling valt buiten je toegangscontext. |
404 | not_found | Thuistestkitbestelling niet gevonden. |
409 | demo_order | De bestelling is een demo-thuistestkitbestelling. Deze heeft geen klant om te e-mailen. |
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/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}