Ordini di kit domiciliari
Invia risultati via email
Avvisa via email il cliente che i risultati di laboratorio del suo kit domiciliare sono pronti
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"
}
Invia al cliente un’email per avvisarlo che i suoi risultati di laboratorio sono pronti. L’email viene inviata
all’
email del profilo dell’ordine di kit domiciliare.
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 del kit. L’email
allega ogni referto che il cliente può vedere nell’app. Impostalo su false per
inviare solo l’avviso. Aggiungi note per mostrare una nota personale nell’email, al massimo 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 nessun 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 hadate_of_birth. Impostalo con Aggiorna profilo, oppure invia conwith_reports: false.- L’ordine è uno degli ordini demo di kit domiciliari. Un ordine demo non ha un cliente a cui inviare l’email.
results_view più lo scope home_kit_orders_view o home_kit_orders_manage.
Richiesta
Parametri di percorso
Identificatore univoco (UUID) dell’ordine di kit domiciliare 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 convalida — 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 gli scope necessari oppure l’ordine di kit domiciliare è fuori dal tuo contesto di accesso. |
404 | not_found | Ordine di kit domiciliare non trovato. |
409 | demo_order | L’ordine è un ordine demo di kit domiciliare. Non ha un cliente a cui inviare l’email. |
409 | no_reports | Non è ancora arrivato nessun 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 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/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"
}