> ## 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`, а також дозвіл `home_kit_orders_view` або `home_kit_orders_manage`.

## Запит

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

**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` | `demo_order` | Це демозамовлення набору для домашнього тесту. У нього немає клієнта, якому можна надіслати лист. |
| `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/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "with_reports": true
  }'
```

```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": "No lab report has arrived yet.",
  "reason": "no_reports"
}
```


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