> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Надіслати результати електронною поштою

> Повідомити клієнта електронною поштою, що його лабораторні результати готові

Надішли клієнту один лист із повідомленням, що його лабораторні результати готові. Лист надходить на
`email` профілю цього запису.

Лист використовує загальний брендинг партнера: назву й логотип основної групи профілів
для цього профілю. Він надсилається мовою `language` профілю, типово — англійською.

Встанови для `with_reports` значення `true`, щоб прикріпити лабораторні звіти запису. До листа
прикріплюється кожен звіт, який клієнт бачить у застосунку. Встанови `false`,
щоб надіслати лише сповіщення. Додай `note`, щоб показати в листі особисту примітку — щонайбільше 1 000 символів.

Кожен прикріплений звіт — це PDF, зашифрований за допомогою AES-256. Пароль — це `date_of_birth`
профілю з 8 цифр у форматі `DDMMYYYY` без крапок: клієнт, який народився 1 лютого 1985 року, вводить
`01021985`. Лист пояснює клієнту цей формат, але ніколи не вказує саму дату народження.

Кожен виклик надсилає один лист. Виклики не дедуплікуються: якщо ти викличеш ендпоїнт двічі, клієнт
отримає два листи.

Лист не надсилається, якщо:

* Ще не надійшов жоден лабораторний звіт.
* У профілі немає електронної адреси або вказана лише тимчасова адреса `@aniva.email`.
* У профілі вимкнено транзакційні листи. Щоб знову їх увімкнути, встанови
  `transactional_emails_enabled` у значення `true` через [Оновити профіль](https://docs.anivahealth.com/uk/api/profiles/update-profile.md).
* `with_reports` має значення `true`, а в профілі немає `date_of_birth`. Вкажи її через
  [Оновити профіль](https://docs.anivahealth.com/uk/api/profiles/update-profile.md) або надішли запит із `with_reports: false`.

Потребує дозволу `results_view`.

## Запит

### Параметри шляху

**id** `string` *required*

Унікальний ідентифікатор (UUID) запису, результати якого потрібно надіслати листом.

### Параметри тіла запиту

**with\_reports** `boolean` *required*

`true` прикріплює лабораторні звіти як PDF-файли, захищені паролем. `false` надсилає лише сповіщення про готовність
результатів.

**note** `string`

Особиста примітка, яка відображається в листі під сповіщенням. Щонайбільше 1 000 символів.

## Відповідь

У разі успіху API повертає `200 OK`.

**recipient\_email** `string` *required*

Адреса, на яку надіслано лист: `email` профілю.

**attachment\_count** `integer` *required*

Кількість прикріплених лабораторних звітів. `0`, якщо `with_reports` має значення `false`.

**sent\_at** `string` *required*

Час надсилання листа в UTC (ISO 8601 із суфіксом `Z`).

## Відповіді з помилками

Тіло помилки містить `error` — зрозуміле людині повідомлення — і `reason` — стабільний код. Помилки валідації
та відсутність дозволу `results_view` не мають `reason`.

| Статус | Причина | Опис |
| - | - | - |
| `400` | — | Помилка валідації — недійсний ID, відсутній `with_reports` або `note` довший за 1 000 символів. |
| `403` | `access_denied` | Доступ заборонено — твій API-ключ не має потрібного дозволу або запис поза межами твого контексту доступу. |
| `404` | `not_found` | Запис не знайдено. |
| `409` | `no_reports` | Ще не надійшов жоден лабораторний звіт. |
| `409` | `no_email` | У профілі немає електронної адреси. |
| `409` | `placeholder_email` | У профілі вказана лише тимчасова адреса `@aniva.email`. Онови профіль, вказавши справжню електронну адресу. |
| `409` | `unsubscribed` | У профілі вимкнено транзакційні листи. Спочатку встанови `transactional_emails_enabled` у значення `true`. |
| `409` | `no_birthdate` | `with_reports` має значення `true`, а в профілі немає `date_of_birth` — пароля для PDF. |
| `413` | `reports_too_large` | Звіти завеликі для одного листа. Надішли лист із `with_reports: false`. |
| `422` | `report_unprotectable` | Звіт не у форматі PDF або його не вдалося захистити паролем. Надішли із `with_reports: false`. |
| `500` | — | Внутрішня помилка сервера. |
| `502` | `report_unavailable` | Не вдалося завантажити лабораторний звіт. Лист не надіслано. |
| `502` | `send_failed` | Поштовий провайдер відхилив лист. Лист не надіслано. |

```bash cURL theme={null}
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."
  }'
```

```json 200 theme={null}
{
  "recipient_email": "maria.schmidt@example.com",
  "attachment_count": 1,
  "sent_at": "2026-10-15T09:12:44.512Z"
}
```

```json 409 theme={null}
{
  "error": "This customer has turned off emails. Turn emails on for them first.",
  "reason": "unsubscribed"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.