Termine
Ergebnisse per E-Mail senden
Den Kunden per E-Mail benachrichtigen, dass seine Laborergebnisse bereitstehen
POST
/
api
/
v1
/
appointments
/
{id}
/
results
/
email
curl --request POST \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}
Sende dem Kunden eine E-Mail, die ihn darüber informiert, dass seine Laborergebnisse vorliegen. Die E-Mail geht an die
email des Profils dieses Termins.
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 Termins anzuhängen. Die E-Mail
hängt jeden Bericht an, den der Kunde in der App sehen kann. Setze den Wert auf false,
um nur die Benachrichtigung zu senden. Füge note hinzu, um eine persönliche Nachricht in der E-Mail anzuzeigen, höchstens 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:
- noch kein Laborbericht eingegangen ist.
- das Profil keine E-Mail-Adresse oder nur eine Platzhalteradresse mit
@aniva.emailhat. - das Profil transaktionale E-Mails deaktiviert hat. Um sie wieder zu aktivieren, setze
transactional_emails_enabledmit Profil aktualisieren auftrue. with_reportsauftruesteht und das Profil keindate_of_birthhat. Lege es mit Profil aktualisieren fest oder sende mitwith_reports: false.
results_view.
Anfrage
Pfadparameter
Eindeutige Kennung (UUID) des Termins, dessen 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 – deinem API-Schlüssel fehlt der Scope, oder der Termin liegt außerhalb deines Zugriffskontexts. |
404 | not_found | Termin nicht gefunden. |
409 | no_reports | Es ist noch kein Laborbericht eingegangen. |
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 | Das Profil hat transaktionale 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 mit einem Passwort geschü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/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}