Pedidos de kits de prueba en casa
Enviar resultados por correo
Avisar por correo al cliente de que los resultados de laboratorio de su kit de prueba en casa están listos
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"
}
Envía al cliente un correo electrónico para avisarle de que sus resultados de laboratorio están listos. El correo se envía al
email del perfil del pedido de kit de prueba en casa.
El correo usa la marca genérica del socio: el nombre y el logo del grupo de perfiles principal
del perfil. Está en el language del perfil, inglés por defecto.
Establece with_reports en true para adjuntar los informes de laboratorio del kit. El correo
adjunta todos los informes que el cliente puede ver en la app. Establécelo en false para
enviar solo el aviso. Añade note para mostrar una nota personal en el correo, con un máximo de 1.000 caracteres.
Cada informe adjunto es un PDF cifrado con AES-256. La contraseña es date_of_birth del
perfil en 8 dígitos, DDMMYYYY, sin puntos: un cliente nacido el 1 de febrero de 1985 escribe
01021985. El correo indica este formato al cliente, pero nunca la fecha de nacimiento en sí.
Cada llamada envía un correo. Las llamadas no se deduplican: si llamas al endpoint dos veces, el cliente
recibe dos correos.
El correo no se envía cuando:
- Todavía no ha llegado ningún informe de laboratorio.
- El perfil no tiene dirección de correo electrónico o solo tiene una dirección provisional
@aniva.email. - El perfil ha desactivado los correos transaccionales. Para volver a activarlos, establece
transactional_emails_enabledentruecon Actualizar perfil. with_reportsestruey el perfil no tienedate_of_birth. Establécelo con Actualizar perfil o envía conwith_reports: false.- El pedido es uno de los pedidos de demostración de kit de prueba en casa. Un pedido de demostración no tiene cliente al que enviar el correo.
results_view más el ámbito home_kit_orders_view o home_kit_orders_manage.
Solicitud
Parámetros de ruta
Identificador único (UUID) del pedido de kit de prueba en casa cuyos resultados quieres enviar por correo.
Parámetros del cuerpo
true adjunta los informes de laboratorio como archivos PDF protegidos con contraseña. false envía solo el aviso de que los resultados están
listos.Respuesta
Si la solicitud tiene éxito, la API devuelve200 OK.
Respuestas de error
El cuerpo de error incluyeerror, un mensaje legible, y reason, un código estable. Los errores de validación
y la falta del scope results_view no tienen reason.
| Estado | Motivo | Descripción |
|---|---|---|
400 | — | Error de validación — ID no válido, falta with_reports o note supera los 1.000 caracteres. |
403 | access_denied | Prohibido — tu clave de API no tiene los ámbitos necesarios o el pedido de kit de prueba en casa está fuera de tu contexto de acceso. |
404 | not_found | Pedido de kit de prueba en casa no encontrado. |
409 | demo_order | El pedido es un pedido de demostración de kit de prueba en casa. No tiene cliente al que enviar el correo. |
409 | no_reports | Todavía no ha llegado ningún informe de laboratorio. |
409 | no_email | El perfil no tiene dirección de correo electrónico. |
409 | placeholder_email | El perfil solo tiene una dirección provisional @aniva.email. Actualiza el perfil con un correo real. |
409 | unsubscribed | El perfil ha desactivado los correos transaccionales. Establece primero transactional_emails_enabled en true. |
409 | no_birthdate | with_reports es true y el perfil no tiene date_of_birth, la contraseña del PDF. |
413 | reports_too_large | Los informes son demasiado grandes para un solo correo. Envía el correo con with_reports: false. |
422 | report_unprotectable | Un informe no es un PDF o no se pudo proteger con contraseña. Envía con with_reports: false. |
500 | — | Error interno del servidor. |
502 | report_unavailable | No se pudo cargar un informe de laboratorio. No se envió ningún correo. |
502 | send_failed | El proveedor de correo rechazó el correo. No se envió ningún correo. |
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"
}