Zum Hauptinhalt springen
POST
Sende dem Kunden eine E-Mail, die ihn darüber informiert, dass seine Laborergebnisse bereitstehen. Die E-Mail geht an die email des Profils der Heimtest-Kit-Bestellung. Die E-Mail nutzt generisches Partner-Branding: den Namen und das Logo der primären Profilgruppe des Profils. Sie ist in der language des Profils, standardmäßig auf Englisch. Setze with_reports auf true, um die Laborberichte des Kits anzuhängen. An die E-Mail wird jeder Bericht angehängt, den der Kunde in der App sehen kann. Setze es auf false, um nur die Benachrichtigung zu senden. Füge note hinzu, um eine persönliche Nachricht in der E-Mail anzuzeigen, maximal 1.000 Zeichen. Jeder angehängte Bericht ist ein mit AES-256 verschlüsseltes PDF. Das Passwort ist das date_of_birth des Profils als 8 Ziffern, DDMMYYYY, ohne Punkte: Ein Kunde, der am 1. Februar 1985 geboren wurde, gibt 01021985 ein. Die E-Mail nennt dem Kunden dieses Format, aber niemals das Geburtsdatum selbst. Jeder Aufruf sendet eine E-Mail. Aufrufe werden nicht dedupliziert: Wenn du den Endpunkt zweimal aufrufst, erhält der Kunde zwei E-Mails. Die E-Mail wird nicht gesendet, wenn:
  • Es liegt noch kein Laborbericht vor.
  • Das Profil hat keine E-Mail-Adresse oder nur eine Platzhalteradresse mit @aniva.email.
  • Im Profil sind Transaktions-E-Mails deaktiviert. Um sie wieder zu aktivieren, setze transactional_emails_enabled über Profil aktualisieren auf true.
  • with_reports ist true und das Profil hat kein date_of_birth. Setze es über Profil aktualisieren oder sende mit with_reports: false.
  • Die Bestellung ist eine der Demo-Heimtest-Kit-Bestellungen. Eine Demo-Bestellung hat keinen Kunden als E-Mail-Empfänger.
Erfordert den Scope results_view sowie den Scope home_kit_orders_view oder home_kit_orders_manage.

Anfrage

Pfadparameter

string
erforderlich
Eindeutige Kennung (UUID) der Heimtest-Kit-Bestellung, deren Ergebnisse per E-Mail gesendet werden sollen.

Body-Parameter

boolean
erforderlich
true hängt die Laborberichte als passwortgeschützte PDF-Dateien an. false sendet nur die Benachrichtigung, dass die Ergebnisse vorliegen.
string
Eine persönliche Nachricht, die in der E-Mail unter der Benachrichtigung angezeigt wird. Höchstens 1.000 Zeichen.

Antwort

Bei Erfolg gibt die API 200 OK zurück.
string
erforderlich
Die Adresse, an die die E-Mail gesendet wurde: die email des Profils.
integer
erforderlich
Die Anzahl der angehängten Laborberichte. 0, wenn with_reports false ist.
string
erforderlich
Zeitpunkt des E-Mail-Versands als UTC-Zeitstempel (ISO 8601 mit Z-Suffix).

Fehlerantworten

Ein Fehler-Body enthält error, eine menschenlesbare Meldung, und reason, einen stabilen Code. Validierungsfehler und ein fehlender results_view-Scope haben kein reason.