Appuntamenti
Invia risultati via email
Invia un’email al cliente per avvisarlo che i risultati di laboratorio sono pronti
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"
}
Invia al cliente un’email per avvisarlo che i suoi risultati di laboratorio sono pronti. L’email viene inviata all’
email
del profilo dell’appuntamento.
L’email usa un branding generico del partner: il nome e il logo del gruppo di profili
principale del profilo. È nella language del profilo, inglese di default.
Imposta with_reports su true per allegare i referti di laboratorio dell’appuntamento. L’email
allega tutti i referti che il cliente può vedere nell’app. Impostalo su false
per inviare solo l’avviso. Aggiungi note per mostrare una nota personale nell’email, fino a 1.000 caratteri.
Ogni referto allegato è un PDF crittografato con AES-256. La password è la date_of_birth del
profilo in 8 cifre, DDMMYYYY, senza punti: un cliente nato il 1° febbraio 1985 inserisce
01021985. L’email indica al cliente questo formato, ma mai la data di nascita stessa.
Ogni chiamata invia un’email. Le chiamate non vengono deduplicate: se chiami l’endpoint due volte, il cliente
riceve due email.
L’email non viene inviata quando:
- Non è ancora arrivato alcun referto di laboratorio.
- Il profilo non ha un indirizzo email oppure ha solo un indirizzo segnaposto
@aniva.email. - Il profilo ha disattivato le email transazionali. Per riattivarle, imposta
transactional_emails_enabledsutruecon Aggiorna profilo. with_reportsètruee il profilo non ha unadate_of_birth. Impostala con Aggiorna profilo oppure invia conwith_reports: false.
results_view.
Richiesta
Parametri di percorso
Identificatore univoco (UUID) dell’appuntamento di cui inviare i risultati via email.
Parametri del body
true allega i referti di laboratorio come file PDF protetti da password. false invia solo l’avviso che i risultati sono
pronti.Risposta
In caso di successo, l’API restituisce200 OK.
Risposte di errore
Il corpo di un errore contieneerror, un messaggio leggibile, e reason, un codice stabile. Gli errori di validazione
e la mancanza dello scope results_view non hanno reason.
| Stato | Motivo | Descrizione |
|---|---|---|
400 | — | Errore di validazione — ID non valido, with_reports mancante o note più lungo di 1.000 caratteri. |
403 | access_denied | Accesso negato — la tua chiave API non ha lo scope richiesto oppure l’appuntamento è fuori dal tuo contesto di accesso. |
404 | not_found | Appuntamento non trovato. |
409 | no_reports | Non è ancora arrivato alcun referto di laboratorio. |
409 | no_email | Il profilo non ha un indirizzo email. |
409 | placeholder_email | Il profilo ha solo un indirizzo segnaposto @aniva.email. Aggiorna il profilo con un’email reale. |
409 | unsubscribed | Il profilo ha disattivato le email transazionali. Imposta prima transactional_emails_enabled su true. |
409 | no_birthdate | with_reports è true e il profilo non ha una date_of_birth, la password del PDF. |
413 | reports_too_large | I referti sono troppo grandi per una sola email. Invia l’email con with_reports: false. |
422 | report_unprotectable | Un referto non è un PDF oppure non è stato possibile proteggerlo con password. Invia con with_reports: false. |
500 | — | Errore interno del server. |
502 | report_unavailable | Non è stato possibile caricare un referto di laboratorio. Nessuna email è stata inviata. |
502 | send_failed | Il provider email ha rifiutato l’email. Nessuna email è stata inviata. |
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"
}