Ordrer på hjemmetestkit
Send resultater på e-mail
Send en e-mail til kunden om, at laboratorieresultaterne fra hjemmetestkittet er klar
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"
}
Send kunden én e-mail, der fortæller dem, at deres laboratorieresultater er klar. E-mailen sendes til
email på profilen for ordren på hjemmetestkittet.
E-mailen bruger generisk partnerbranding: navnet og logoet for profilens primære
profilgruppe. Den er på profilens language, engelsk som standard.
Sæt with_reports til true for at vedhæfte kittets laboratorierapporter. I e-mailen
vedhæftes alle rapporter, som kunden kan se i appen. Sæt feltet til false for
kun at sende meddelelsen. Tilføj note for at vise en personlig note i e-mailen, højst 1.000 tegn.
Hver vedhæftet rapport er en PDF krypteret med AES-256. Adgangskoden er profilens
date_of_birth som 8 cifre, DDMMYYYY, uden punktummer: en kunde født den 1. februar 1985 indtaster
01021985. E-mailen oplyser kunden om dette format, men aldrig selve fødselsdatoen.
Hvert kald sender én e-mail. Kald deduplikeres ikke: hvis du kalder endpointet to gange, får kunden
to e-mails.
E-mailen sendes ikke, når:
- Der er ikke kommet nogen laboratorierapport endnu.
- Profilen har ingen e-mailadresse eller kun en
@aniva.email-pladsholderadresse. - Profilen har slået transaktionelle e-mails fra. Slå dem til igen ved at sætte
transactional_emails_enabledtiltruemed Opdater profil. with_reportsertrue, og profilen har ingendate_of_birth. Angiv den med Opdater profil, eller send medwith_reports: false.- Ordren er en af demoordrerne på hjemmetestkits. En demoordre har ingen kunde at sende e-mail til.
results_view plus scopet home_kit_orders_view eller home_kit_orders_manage.
Forespørgsel
Stiparametre
Unik identifikator (UUID) for hjemmetestkitordren, hvis resultater skal sendes på e-mail.
Body-parametre
true vedhæfter laboratorierapporterne som adgangskodebeskyttede PDF-filer. false sender kun beskeden om, at resultaterne er
klar.Svar
Ved succes returnerer API’et200 OK.
Fejlsvar
En fejl-body indeholdererror, en menneskelæsbar besked, og reason, en stabil kode. Valideringsfejl
og et manglende results_view-scope har ingen reason.
| Status | Årsag | Beskrivelse |
|---|---|---|
400 | — | Valideringsfejl — ugyldigt ID, manglende with_reports, eller note er længere end 1.000 tegn. |
403 | access_denied | Ingen adgang — din API-nøgle har ikke de nødvendige scopes, eller hjemmetestkitordren ligger uden for din adgangskontekst. |
404 | not_found | Hjemmetestkitordren blev ikke fundet. |
409 | demo_order | Ordren er en demoordre på et hjemmetestkit. Den har ingen kunde at sende e-mail til. |
409 | no_reports | Der er ikke kommet nogen laboratorierapport endnu. |
409 | no_email | Profilen har ingen e-mailadresse. |
409 | placeholder_email | Profilen har kun en @aniva.email-pladsholderadresse. Opdater profilen med en rigtig e-mailadresse. |
409 | unsubscribed | Profilen har slået transaktionelle e-mails fra. Sæt først transactional_emails_enabled til true. |
409 | no_birthdate | with_reports er true, og profilen har ingen date_of_birth, som er PDF-adgangskoden. |
413 | reports_too_large | Rapporterne er for store til én e-mail. Send e-mailen med with_reports: false. |
422 | report_unprotectable | En rapport er ikke en PDF, eller den kunne ikke beskyttes med adgangskode. Send med with_reports: false. |
500 | — | Intern serverfejl. |
502 | report_unavailable | En laboratorierapport kunne ikke indlæses. Der blev ikke sendt nogen e-mail. |
502 | send_failed | E-mailudbyderen afviste e-mailen. Der blev ikke sendt nogen e-mail. |
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"
}