Pieraksti
Nosūtīt rezultātus e-pastā
Nosūtīt klientam e-pastu, ka laboratorijas rezultāti ir gatavi
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"
}
Nosūti klientam vienu e-pastu ar ziņu, ka laboratorijas rezultāti ir gatavi. E-pasts tiek nosūtīts uz
pieraksta profila
email adresi.
E-pastā izmantots vispārīgs partnera zīmola noformējums: profila galvenās profilu grupas
nosaukums un logotips. Tas ir profila language valodā, pēc noklusējuma angļu valodā.
Iestati with_reports uz true, lai pievienotu pieraksta laboratorijas pārskatus. E-pastam
tiek pievienots katrs pārskats, ko klients redz lietotnē. Iestati to uz false,
lai nosūtītu tikai paziņojumu. Pievieno note, lai e-pastā parādītu personīgu piezīmi, ne vairāk kā 1 000 rakstzīmju.
Katrs pievienotais pārskats ir PDF fails, kas šifrēts ar AES-256. Parole ir profila date_of_birth
kā 8 cipari, DDMMYYYY, bez punktiem: klients, kurš dzimis 1985. gada 1. februārī, ievada
01021985. E-pastā klientam ir norādīts šis formāts, bet nekad pats dzimšanas datums.
Katrs izsaukums nosūta vienu e-pastu. Izsaukumi netiek deduplicēti: ja izsauc galapunktu divreiz, klients
saņem divus e-pastus.
E-pasts netiek nosūtīts, ja:
- Vēl nav saņemts neviens laboratorijas pārskats.
- Profilam nav e-pasta adreses vai ir tikai pagaidu
@aniva.emailadrese. - Profilā ir izslēgti transakciju e-pasti. Lai tos atkal ieslēgtu, iestati
transactional_emails_enableduztrue, izmantojot Atjaunināt profilu. with_reportsirtrue, un profilam nav norādītsdate_of_birth. Iestati to, izmantojot Atjaunināt profilu, vai nosūti arwith_reports: false.
results_view tvērums.
Pieprasījums
Ceļa parametri
Pieprasījuma satura parametri
true pievieno laboratorijas pārskatus kā ar paroli aizsargātus PDF failus. false nosūta tikai paziņojumu, ka rezultāti ir
gatavi.Atbilde
Veiksmes gadījumā API atgriež200 OK.
Kļūdu atbildes
Kļūdas atbildes saturā irerror (cilvēkam lasāms ziņojums) un reason (stabils kods). Validācijas kļūdām
un trūkstošam results_view tvērumam nav reason.
| Statuss | Iemesls | Apraksts |
|---|---|---|
400 | — | Validācijas kļūda — nederīgs ID, trūkst with_reports vai note ir garāka par 1 000 rakstzīmēm. |
403 | access_denied | Aizliegts — tavai API atslēgai nav šī tvēruma, vai pieraksts ir ārpus tava piekļuves konteksta. |
404 | not_found | Pieraksts nav atrasts. |
409 | no_reports | Vēl nav saņemts neviens laboratorijas pārskats. |
409 | no_email | Profilam nav e-pasta adreses. |
409 | placeholder_email | Profilam ir tikai pagaidu @aniva.email adrese. Atjaunini profilu ar īstu e-pasta adresi. |
409 | unsubscribed | Profilā ir izslēgti transakciju e-pasti. Vispirms iestati transactional_emails_enabled uz true. |
409 | no_birthdate | with_reports ir true, un profilam nav date_of_birth — PDF paroles. |
413 | reports_too_large | Pārskati ir pārāk lieli vienam e-pastam. Nosūti e-pastu ar with_reports: false. |
422 | report_unprotectable | Pārskats nav PDF vai to nevarēja aizsargāt ar paroli. Nosūti ar with_reports: false. |
500 | — | Iekšēja servera kļūda. |
502 | report_unavailable | Laboratorijas pārskatu nevarēja ielādēt. E-pasts netika nosūtīts. |
502 | send_failed | E-pasta pakalpojumu sniedzējs noraidīja e-pastu. E-pasts netika nosūtīts. |
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"
}