Beställningar av hemtestkit
Mejla resultat
Mejla kunden om att labbresultaten från hemtestkitet är klara
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"
}
Skicka ett mejl till kunden som meddelar att labbresultaten är klara. Mejlet skickas till
email på hemtestkitbeställningens profil.
Mejlet använder generell partnerprofilering: namnet och logotypen för profilens primära
profilgrupp. Det är på profilens language, engelska som standard.
Sätt with_reports till true för att bifoga kitets labbrapporter. I mejlet
bifogas alla rapporter som kunden kan se i appen. Sätt det till false för att
bara skicka aviseringen. Lägg till note för att visa ett personligt meddelande i mejlet, högst 1 000 tecken.
Varje bifogad rapport är en PDF krypterad med AES-256. Lösenordet är profilens date_of_birth
som 8 siffror, DDMMYYYY, utan punkter: en kund som är född 1 februari 1985 skriver
01021985. Mejlet talar om det här formatet för kunden, men aldrig själva födelsedatumet.
Varje anrop skickar ett mejl. Anrop dedupliceras inte: om du anropar endpointen två gånger får kunden
två mejl.
Mejlet skickas inte när:
- Ingen labbrapport har kommit in ännu.
- Profilen har ingen e-postadress, eller bara en platshållaradress med
@aniva.email. - Profilen har stängt av transaktionsmejl. För att slå på dem igen, sätt
transactional_emails_enabledtilltruemed Uppdatera profil. with_reportsärtrueoch profilen saknardate_of_birth. Ange det med Uppdatera profil, eller skicka medwith_reports: false.- Beställningen är en av demobeställningarna av hemtestkit. En demobeställning har ingen kund att mejla.
results_view samt behörigheten home_kit_orders_view eller home_kit_orders_manage.
Förfrågan
Sökvägsparametrar
Unik identifierare (UUID) för den beställning av hemtestkit vars resultat ska mejlas.
Body-parametrar
true bifogar labbrapporterna som lösenordsskyddade PDF-filer. false skickar bara aviseringen om att resultaten är
klara.Svar
Vid framgång returnerar API:et200 OK.
Felsvar
En fel-body harerror, ett läsbart meddelande, och reason, en stabil kod. Valideringsfel
och ett saknat results_view-scope har inget reason.
| Status | Orsak | Beskrivning |
|---|---|---|
400 | — | Valideringsfel – ogiltigt ID, with_reports saknas eller note är längre än 1 000 tecken. |
403 | access_denied | Förbjudet – din API-nyckel saknar behörigheterna, eller så ligger beställningen av hemtestkit utanför din åtkomstkontext. |
404 | not_found | Beställningen av hemtestkit hittades inte. |
409 | demo_order | Beställningen är en demobeställning av hemtestkit. Den har ingen kund att mejla. |
409 | no_reports | Ingen labbrapport har kommit in ännu. |
409 | no_email | Profilen har ingen e-postadress. |
409 | placeholder_email | Profilen har bara en platshållaradress med @aniva.email. Uppdatera profilen med en riktig e-postadress. |
409 | unsubscribed | Profilen har stängt av transaktionsmejl. Sätt transactional_emails_enabled till true först. |
409 | no_birthdate | with_reports är true och profilen saknar date_of_birth, som används som PDF-lösenord. |
413 | reports_too_large | Rapporterna är för stora för ett mejl. Skicka mejlet med with_reports: false. |
422 | report_unprotectable | En rapport är inte en PDF, eller kunde inte lösenordsskyddas. Skicka med with_reports: false. |
500 | — | Internt serverfel. |
502 | report_unavailable | En labbrapport kunde inte läsas in. Inget mejl skickades. |
502 | send_failed | E-postleverantören nekade mejlet. Inget mejl skickades. |
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"
}