Termíny
Odeslat výsledky e-mailem
Odeslat zákazníkovi e-mail, že má připravené laboratorní výsledky
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"
}
Pošli zákazníkovi jeden e-mail s informací, že má laboratorní výsledky připravené. E-mail se odešle na adresu
email v profilu daného termínu.
E-mail používá obecný partnerský branding: název a logo primární profilové
skupiny profilu. Je v jazyce language profilu, výchozí je angličtina.
Nastav with_reports na true, pokud chceš přiložit laboratorní zprávy k termínu. E-mail
přiloží každou zprávu, kterou zákazník vidí v aplikaci. Nastavením na false
odešleš jen oznámení. Přidej note pro zobrazení osobní poznámky v e-mailu, maximálně 1 000 znaků.
Každá přiložená zpráva je PDF zašifrované pomocí AES-256. Heslem je date_of_birth z
profilu jako 8 číslic ve formátu DDMMYYYY bez teček: zákazník narozený 1. února 1985 zadá
01021985. E-mail zákazníkovi tento formát sdělí, ale nikdy samotné datum narození.
Každé volání odešle jeden e-mail. Volání se nededuplikují: když endpoint zavoláš dvakrát, zákazník
dostane dva e-maily.
E-mail se neodešle, když:
- Zatím nedorazila žádná laboratorní zpráva.
- Profil nemá žádnou e-mailovou adresu, nebo má jen zástupnou adresu
@aniva.email. - Profil má vypnuté transakční e-maily. Pokud je chceš znovu zapnout, nastav
transactional_emails_enablednatruepřes Aktualizovat profil. - Hodnota
with_reportsjetruea profil nemá vyplněnédate_of_birth. Nastav ho přes Aktualizovat profil, nebo odešli požadavek swith_reports: false.
results_view.
Požadavek
Parametry cesty
Parametry těla
true přiloží laboratorní zprávy jako PDF soubory chráněné heslem. false odešle jen oznámení, že jsou výsledky
připravené.Odpověď
Při úspěchu vrátí API200 OK.
Chybové odpovědi
Tělo chyby obsahujeerror, srozumitelnou zprávu, a reason, stabilní kód. Chyby validace
a chybějící scope results_view pole reason nemají.
| Stav | Důvod | Popis |
|---|---|---|
400 | — | Chyba validace — neplatné ID, chybějící with_reports nebo note delší než 1 000 znaků. |
403 | access_denied | Zakázáno — tvůj API klíč nemá tento scope, nebo je termín mimo tvůj přístupový kontext. |
404 | not_found | Termín nebyl nalezen. |
409 | no_reports | Zatím nedorazila žádná laboratorní zpráva. |
409 | no_email | Profil nemá žádnou e-mailovou adresu. |
409 | placeholder_email | Profil má jen zástupnou adresu @aniva.email. Aktualizuj profil skutečným e-mailem. |
409 | unsubscribed | Profil má vypnuté transakční e-maily. Nejdřív nastav transactional_emails_enabled na true. |
409 | no_birthdate | with_reports je true a profil nemá date_of_birth, které slouží jako heslo k PDF. |
413 | reports_too_large | Zprávy jsou na jeden e-mail příliš velké. Odešli e-mail s with_reports: false. |
422 | report_unprotectable | Zpráva není PDF nebo ji nešlo zaheslovat. Odešli s with_reports: false. |
500 | — | Interní chyba serveru. |
502 | report_unavailable | Laboratorní zprávu se nepodařilo načíst. Žádný e-mail se neodeslal. |
502 | send_failed | Poskytovatel e-mailu zprávu odmítl. Žádný e-mail se neodeslal. |
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"
}