Wizyty
Wyślij wyniki e-mailem
Wyślij klientowi e-mail z informacją, że jego wyniki laboratoryjne są gotowe
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"
}
Wyślij klientowi jeden e-mail z informacją, że jego wyniki laboratoryjne są gotowe. Wiadomość trafia na
adres
email z profilu wizyty.
E-mail korzysta z ogólnego brandingu partnera: nazwy i logo głównej grupy profili
tego profilu. Jest w języku language profilu, domyślnie po angielsku.
Ustaw with_reports na true, aby dołączyć raporty laboratoryjne z wizyty. Do e-maila
dołączany jest każdy raport, który klient widzi w aplikacji. Ustaw wartość false,
aby wysłać samo powiadomienie. Dodaj note, aby wyświetlić w e-mailu osobistą wiadomość, maksymalnie 1 000 znaków.
Każdy załączony raport to plik PDF zaszyfrowany algorytmem AES-256. Hasłem jest pole date_of_birth
profilu jako 8 cyfr, DDMMYYYY, bez kropek: klient urodzony 1 lutego 1985 wpisuje
01021985. E-mail podaje klientowi ten format, ale nigdy samej daty urodzenia.
Każde wywołanie wysyła jeden e-mail. Wywołania nie są deduplikowane: jeśli wywołasz endpoint dwa razy, klient
dostanie dwa e-maile.
E-mail nie jest wysyłany, gdy:
- Nie wpłynął jeszcze żaden raport laboratoryjny.
- Profil nie ma adresu e-mail albo ma tylko zastępczy adres
@aniva.email. - Profil ma wyłączone e-maile transakcyjne. Aby włączyć je ponownie, ustaw
transactional_emails_enablednatrueza pomocą Zaktualizuj profil. - Pole
with_reportsma wartośćtrue, a profil nie ma poladate_of_birth. Ustaw je za pomocą Zaktualizuj profil albo wyślij zwith_reports: false.
results_view.
Żądanie
Parametry ścieżki
Parametry treści
true dołącza raporty laboratoryjne jako pliki PDF chronione hasłem. false wysyła tylko powiadomienie, że wyniki są
gotowe.Odpowiedź
W razie powodzenia API zwraca200 OK.
Odpowiedzi z błędami
Treść błędu zawiera poleerror z czytelnym komunikatem oraz reason ze stałym kodem. Błędy walidacji
i brak zakresu results_view nie mają pola reason.
| Status | Powód | Opis |
|---|---|---|
400 | — | Błąd walidacji — nieprawidłowe ID, brak with_reports lub note dłuższe niż 1 000 znaków. |
403 | access_denied | Brak dostępu — twój klucz API nie ma wymaganego zakresu lub wizyta znajduje się poza twoim kontekstem dostępu. |
404 | not_found | Nie znaleziono wizyty. |
409 | no_reports | Nie wpłynął jeszcze żaden raport laboratoryjny. |
409 | no_email | Profil nie ma adresu e-mail. |
409 | placeholder_email | Profil ma tylko zastępczy adres @aniva.email. Zaktualizuj profil, podając prawdziwy adres e-mail. |
409 | unsubscribed | Profil ma wyłączone e-maile transakcyjne. Najpierw ustaw transactional_emails_enabled na true. |
409 | no_birthdate | Pole with_reports ma wartość true, a profil nie ma pola date_of_birth, które jest hasłem do pliku PDF. |
413 | reports_too_large | Raporty są zbyt duże jak na jeden e-mail. Wyślij e-mail z with_reports: false. |
422 | report_unprotectable | Raport nie jest plikiem PDF lub nie udało się go zabezpieczyć hasłem. Wyślij z with_reports: false. |
500 | — | Wewnętrzny błąd serwera. |
502 | report_unavailable | Nie udało się wczytać raportu laboratoryjnego. E-mail nie został wysłany. |
502 | send_failed | Dostawca poczty odrzucił wiadomość. E-mail nie został wysłany. |
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"
}