Passer au contenu principal
POST
Envoie au client un e-mail l’informant que ses résultats de laboratoire sont prêts. L’e-mail est envoyé à l’adresse email du profil de la commande de kit à domicile. L’e-mail utilise une identité visuelle partenaire générique : le nom et le logo du groupe de profils principal du profil. Il est dans la language du profil, en anglais par défaut. Définis with_reports sur true pour joindre les rapports de laboratoire du kit. L’e-mail joint chaque rapport que le client peut voir dans l’application. Définis-le sur false pour n’envoyer que la notification. Ajoute note pour afficher une note personnelle dans l’e-mail, de 1 000 caractères maximum. Chaque rapport joint est un PDF chiffré en AES-256. Le mot de passe est la date_of_birth du profil sous forme de 8 chiffres, DDMMYYYY, sans points : un client né le 1er février 1985 saisit 01021985. L’e-mail indique ce format au client, mais jamais la date de naissance elle-même. Chaque appel envoie un e-mail. Les appels ne sont pas dédupliqués : si tu appelles le point de terminaison deux fois, le client reçoit deux e-mails. L’e-mail n’est pas envoyé lorsque :
  • Aucun rapport de laboratoire n’est encore arrivé.
  • Le profil n’a pas d’adresse e-mail, ou uniquement une adresse fictive @aniva.email.
  • Le profil a désactivé les e-mails transactionnels. Pour les réactiver, définis transactional_emails_enabled sur true avec Mettre à jour le profil.
  • with_reports vaut true et le profil n’a pas de date_of_birth. Définis-la avec Mettre à jour le profil, ou envoie avec with_reports: false.
  • La commande fait partie des commandes de kit à domicile de démonstration. Une commande de démonstration n’a pas de client à qui envoyer d’e-mail.
Nécessite le scope results_view ainsi que le scope home_kit_orders_view ou home_kit_orders_manage.

Requête

Paramètres de chemin

string
requis
Identifiant unique (UUID) de la commande de kit à domicile dont les résultats doivent être envoyés par e-mail.

Paramètres du corps

boolean
requis
true joint les rapports de laboratoire sous forme de fichiers PDF protégés par mot de passe. false envoie uniquement la notification indiquant que les résultats sont prêts.
string
Une note personnelle affichée dans l’e-mail sous la notification. 1 000 caractères maximum.

Réponse

En cas de succès, l’API renvoie 200 OK.
string
requis
L’adresse à laquelle l’e-mail a été envoyé : l’email du profil.
integer
requis
Le nombre de rapports de laboratoire joints. 0 lorsque with_reports est false.
string
requis
Date et heure d’envoi de l’e-mail, en temps UTC (ISO 8601 avec suffixe Z).

Réponses d’erreur

Un corps d’erreur contient error, un message lisible par un humain, et reason, un code stable. Les erreurs de validation et l’absence du scope results_view n’ont pas de reason.