Bestillinger av hjemmetestsett
Send resultater på e-post
Send e-post til kunden om at labresultatene fra hjemmetestsettet er klare
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-post som gir beskjed om at laboratorieresultatene er klare. E-posten sendes til
email på profilen til bestillingen av hjemmetestsett.
E-posten bruker generell partnerprofilering: navnet og logoen til profilens primære
profilgruppe. Den er på profilens language, med engelsk som standard.
Sett with_reports til true for å legge ved laboratorierapportene for settet. E-posten
legger ved hver rapport kunden kan se i appen. Sett den til false for å
sende bare varselet. Legg til note for å vise en personlig melding i e-posten, maks 1 000 tegn.
Hver vedlagt rapport er en PDF kryptert med AES-256. Passordet er date_of_birth på
profilen som 8 sifre, DDMMYYYY, uten punktum: En kunde født 1. februar 1985 skriver
01021985. E-posten forteller kunden dette formatet, men aldri selve fødselsdatoen.
Hvert kall sender én e-post. Kall blir ikke deduplisert: Hvis du kaller endepunktet to ganger, får kunden
to e-poster.
E-posten blir ikke sendt når:
- Ingen laboratorierapport har kommet ennå.
- Profilen har ingen e-postadresse, eller bare en
@aniva.email-plassholderadresse. - Profilen har slått av transaksjonelle e-poster. For å slå dem på igjen setter du
transactional_emails_enabledtiltruemed Oppdater profil. with_reportsertrueog profilen har ingendate_of_birth. Sett den med Oppdater profil, eller send medwith_reports: false.- Bestillingen er en av demobestillingene av hjemmetestsett. En demobestilling har ingen kunde å sende e-post til.
results_view i tillegg til scopet home_kit_orders_view eller home_kit_orders_manage.
Forespørsel
Stiparametere
Unik identifikator (UUID) for bestillingen av hjemmetestsett som resultatene skal sendes på e-post for.
Body-parametere
true legger ved laboratorierapportene som passordbeskyttede PDF-filer. false sender bare varselet om at resultatene er
klare.Respons
Ved suksess returnerer API-et200 OK.
Feilresponser
En feilrespons harerror, en lesbar melding, og reason, en stabil kode. Valideringsfeil
og manglende results_view-scope har ingen reason.
| Status | Årsak | Beskrivelse |
|---|---|---|
400 | — | Valideringsfeil – ugyldig ID, manglende with_reports eller note lengre enn 1 000 tegn. |
403 | access_denied | Ingen tilgang – API-nøkkelen din mangler de nødvendige scopene, eller bestillingen av hjemmetestsett ligger utenfor tilgangskonteksten din. |
404 | not_found | Bestilling av hjemmetestsett ikke funnet. |
409 | demo_order | Bestillingen er en demobestilling av hjemmetestsett. Den har ingen kunde å sende e-post til. |
409 | no_reports | Ingen laboratorierapport har kommet ennå. |
409 | no_email | Profilen har ingen e-postadresse. |
409 | placeholder_email | Profilen har bare en @aniva.email-plassholderadresse. Oppdater profilen med en ekte e-postadresse. |
409 | unsubscribed | Profilen har slått av transaksjonelle e-poster. Sett transactional_emails_enabled til true først. |
409 | no_birthdate | with_reports er true og profilen har ingen date_of_birth, som er PDF-passordet. |
413 | reports_too_large | Rapportene er for store for én e-post. Send e-posten med with_reports: false. |
422 | report_unprotectable | En rapport er ikke en PDF, eller kunne ikke passordbeskyttes. Send med with_reports: false. |
500 | — | Intern serverfeil. |
502 | report_unavailable | En laboratorierapport kunne ikke lastes inn. Ingen e-post ble sendt. |
502 | send_failed | E-postleverandøren avviste e-posten. Ingen e-post ble sendt. |
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"
}