Tider
Send resultater på e-mail
Send en e-mail til kunden om, at laboratorieresultaterne er klar
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"
}
Send kunden én e-mail om, at laboratorieresultaterne er klar. E-mailen sendes til
email på tidens profil.
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 tidens laboratorierapporter. E-mailen
vedhæfter alle rapporter, som kunden kan se i appen. Sæt den til false
for kun at sende beskeden. 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:
- Ingen laboratorierapport er ankommet endnu.
- Profilen har ingen e-mailadresse eller kun en
@aniva.email-pladsholderadresse. - Profilen har slået transaktionelle e-mails fra. For at slå dem til igen skal du sætte
transactional_emails_enabledtiltruemed Opdater profil. with_reportsertrue, og profilen har ingendate_of_birth. Sæt den med Opdater profil, eller send medwith_reports: false.
results_view.
Forespørgsel
Stiparametre
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 på over 1.000 tegn. |
403 | access_denied | Adgang nægtet — din API-nøgle har ikke scopet, eller tiden ligger uden for din adgangskontekst. |
404 | not_found | Tiden blev ikke fundet. |
409 | no_reports | Ingen laboratorierapport er ankommet 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 transactional_emails_enabled til true først. |
409 | no_birthdate | with_reports er true, og profilen har ingen date_of_birth, som bruges som PDF-adgangskode. |
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 kunne ikke adgangskodebeskyttes. Send med with_reports: false. |
500 | — | Intern serverfejl. |
502 | report_unavailable | En laboratorierapport kunne ikke indlæses. Ingen e-mail blev sendt. |
502 | send_failed | E-mailudbyderen afviste e-mailen. Ingen e-mail blev sendt. |
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"
}