Saltar al contenido principal
POST
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_enabled en true con Actualizar perfil.
  • with_reports es true y el perfil no tiene date_of_birth. Establécelo con Actualizar perfil o envía con with_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.
Requiere el ámbito results_view más el ámbito home_kit_orders_view o home_kit_orders_manage.

Solicitud

Parámetros de ruta

string
requerido
Identificador único (UUID) del pedido de kit de prueba en casa cuyos resultados quieres enviar por correo.

Parámetros del cuerpo

boolean
requerido
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.
string
Nota personal que el correo muestra debajo del aviso. Como máximo 1.000 caracteres.

Respuesta

Si la solicitud tiene éxito, la API devuelve 200 OK.
string
requerido
Dirección a la que se envió el correo: el email del perfil.
integer
requerido
Número de informes de laboratorio adjuntos. 0 cuando with_reports es false.
string
requerido
Momento en que se envió el correo, como instante UTC (ISO 8601 con sufijo Z).

Respuestas de error

El cuerpo de error incluye error, un mensaje legible, y reason, un código estable. Los errores de validación y la falta del scope results_view no tienen reason.