Heimtest-Kit-Bestellungen
Ergebnisse per E-Mail senden
Dem Kunden per E-Mail mitteilen, dass die Laborergebnisse seines Heimtest-Kits bereitstehen
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"
}
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 auftrue. with_reportsisttrueund das Profil hat keindate_of_birth. Setze es über Profil aktualisieren oder sende mitwith_reports: false.- Die Bestellung ist eine der Demo-Heimtest-Kit-Bestellungen. Eine Demo-Bestellung hat keinen Kunden als E-Mail-Empfänger.
results_view sowie den Scope home_kit_orders_view oder home_kit_orders_manage.
Anfrage
Pfadparameter
Eindeutige Kennung (UUID) der Heimtest-Kit-Bestellung, deren Ergebnisse per E-Mail gesendet werden sollen.
Body-Parameter
true hängt die Laborberichte als passwortgeschützte PDF-Dateien an. false sendet nur die Benachrichtigung, dass die Ergebnisse
vorliegen.Eine persönliche Nachricht, die in der E-Mail unter der Benachrichtigung angezeigt wird. Höchstens 1.000 Zeichen.
Antwort
Bei Erfolg gibt die API200 OK zurück.
Fehlerantworten
Ein Fehler-Body enthälterror, eine menschenlesbare Meldung, und reason, einen stabilen Code. Validierungsfehler
und ein fehlender results_view-Scope haben kein reason.
| Status | Grund | Beschreibung |
|---|---|---|
400 | – | Validierungsfehler – ungültige ID, fehlendes with_reports oder note länger als 1.000 Zeichen. |
403 | access_denied | Zugriff verweigert – dein API-Schlüssel hat nicht die erforderlichen Scopes oder die Heimtest-Kit-Bestellung liegt außerhalb deines Zugriffskontexts. |
404 | not_found | Heimtest-Kit-Bestellung nicht gefunden. |
409 | demo_order | Die Bestellung ist eine Demo-Heimtest-Kit-Bestellung. Sie hat keinen Kunden als E-Mail-Empfänger. |
409 | no_reports | Es liegt noch kein Laborbericht vor. |
409 | no_email | Das Profil hat keine E-Mail-Adresse. |
409 | placeholder_email | Das Profil hat nur eine Platzhalteradresse mit @aniva.email. Aktualisiere das Profil mit einer echten E-Mail-Adresse. |
409 | unsubscribed | Im Profil sind Transaktions-E-Mails deaktiviert. Setze zuerst transactional_emails_enabled auf true. |
409 | no_birthdate | with_reports ist true und das Profil hat kein date_of_birth, das als PDF-Passwort dient. |
413 | reports_too_large | Die Berichte sind zu groß für eine E-Mail. Sende die E-Mail mit with_reports: false. |
422 | report_unprotectable | Ein Bericht ist kein PDF oder konnte nicht passwortgeschützt werden. Sende mit with_reports: false. |
500 | – | Interner Serverfehler. |
502 | report_unavailable | Ein Laborbericht konnte nicht geladen werden. Es wurde keine E-Mail gesendet. |
502 | send_failed | Der E-Mail-Anbieter hat die E-Mail abgelehnt. Es wurde keine E-Mail gesendet. |
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"
}