> ## 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.

# Lähetä tulokset sähköpostitse

> Ilmoita asiakkaalle sähköpostitse, että kotitestipakkauksen laboratoriotulokset ovat valmiit

Lähetä asiakkaalle yksi sähköposti, jossa kerrotaan laboratoriotulosten olevan valmiit. Sähköposti
lähetetään kotitestipakkauksen tilauksen profiilin `email`-osoitteeseen.

Sähköpostissa käytetään yleistä kumppanibrändäystä: profiilin ensisijaisen profiiliryhmän
nimeä ja logoa. Se on profiilin `language`-kielellä, oletuksena englanniksi.

Aseta `with_reports` arvoon `true`, kun haluat liittää pakkauksen laboratorioraportit mukaan. Sähköpostiin
liitetään jokainen raportti, jonka asiakas näkee sovelluksessa. Aseta arvoksi `false`, kun haluat
lähettää vain ilmoituksen. Lisää `note`, jos haluat näyttää sähköpostissa henkilökohtaisen viestin, enintään 1 000 merkkiä.

Jokainen liitetty raportti on AES-256-salattu PDF. Salasana on profiilin `date_of_birth`
8 numerona muodossa `DDMMYYYY` ilman pisteitä: 1. helmikuuta 1985 syntynyt asiakas kirjoittaa
`01021985`. Sähköposti kertoo asiakkaalle tämän muodon, mutta ei koskaan itse syntymäaikaa.

Jokainen kutsu lähettää yhden sähköpostin. Päällekkäisiä kutsuja ei suodateta: jos kutsut päätepistettä kahdesti, asiakas
saa kaksi sähköpostia.

Sähköpostia ei lähetetä, kun:

* Yhtään laboratorioraporttia ei ole vielä saapunut.
* Profiililla ei ole sähköpostiosoitetta tai sillä on vain paikkamerkkinä oleva `@aniva.email`-osoite.
* Profiilissa on poistettu tapahtumasähköpostit käytöstä. Ota ne uudelleen käyttöön asettamalla
  `transactional_emails_enabled` arvoon `true` päätepisteellä [Päivitä profiili](https://docs.anivahealth.com/fi/api/profiles/update-profile.md).
* `with_reports` on `true`, eikä profiililla ole `date_of_birth`-arvoa. Aseta se päätepisteellä
  [Päivitä profiili](https://docs.anivahealth.com/fi/api/profiles/update-profile.md) tai lähetä arvolla `with_reports: false`.
* Tilaus on yksi kotitestipakkausten demotilauksista. Demotilauksella ei ole asiakasta, jolle sähköpostin voisi lähettää.

Vaatii `results_view`-käyttöoikeuden sekä `home_kit_orders_view`- tai `home_kit_orders_manage`-käyttöoikeuden.

## Pyyntö

### Polkuparametrit

**id** `string` *required*

Sen kotitestipakkaustilauksen yksilöllinen tunniste (UUID), jonka tulokset lähetetään sähköpostitse.

### Runkoparametrit

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

`true` liittää laboratorioraportit salasanasuojattuina PDF-tiedostoina. `false` lähettää vain ilmoituksen siitä, että tulokset ovat
valmiit.

**note** `string`

Henkilökohtainen viesti, joka näytetään sähköpostissa ilmoituksen alla. Enintään 1 000 merkkiä.

## Vastaus

Onnistuessaan API palauttaa `200 OK`.

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

Osoite, johon sähköposti lähetettiin: profiilin `email`.

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

Liitettyjen laboratorioraporttien määrä. `0`, kun `with_reports` on `false`.

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

Sähköpostin lähetysaika UTC-ajankohtana (ISO 8601 `Z`-päätteellä).

## Virhevastaukset

Virhevastauksen rungossa on ihmisen luettava viesti `error` ja pysyvä koodi `reason`. Validointivirheillä
ja puuttuvalla `results_view`-käyttöoikeudella ei ole `reason`-kenttää.

| Tila | Syy | Kuvaus |
| - | - | - |
| `400` | — | Validointivirhe — virheellinen tunnus, puuttuva `with_reports` tai yli 1 000 merkkiä pitkä `note`. |
| `403` | `access_denied` | Kielletty — API-avaimellasi ei ole tarvittavia käyttöoikeuksia tai kotitestipakkaustilaus on käyttöoikeusalueesi ulkopuolella. |
| `404` | `not_found` | Kotitestipakkaustilausta ei löytynyt. |
| `409` | `demo_order` | Tilaus on kotitestipakkauksen demotilaus. Sillä ei ole asiakasta, jolle sähköpostin voisi lähettää. |
| `409` | `no_reports` | Yhtään laboratorioraporttia ei ole vielä saapunut. |
| `409` | `no_email` | Profiililla ei ole sähköpostiosoitetta. |
| `409` | `placeholder_email` | Profiililla on vain paikkamerkkinä oleva `@aniva.email`-osoite. Päivitä profiiliin oikea sähköpostiosoite. |
| `409` | `unsubscribed` | Profiilissa on poistettu tapahtumasähköpostit käytöstä. Aseta ensin `transactional_emails_enabled` arvoon `true`. |
| `409` | `no_birthdate` | `with_reports` on `true`, eikä profiililla ole PDF:n salasanana toimivaa `date_of_birth`-arvoa. |
| `413` | `reports_too_large` | Raportit ovat liian suuria yhteen sähköpostiin. Lähetä sähköposti arvolla `with_reports: false`. |
| `422` | `report_unprotectable` | Raportti ei ole PDF-tiedosto tai sitä ei voitu suojata salasanalla. Lähetä arvolla `with_reports: false`. |
| `500` | — | Sisäinen palvelinvirhe. |
| `502` | `report_unavailable` | Laboratorioraporttia ei voitu ladata. Sähköpostia ei lähetetty. |
| `502` | `send_failed` | Sähköpostipalveluntarjoaja hylkäsi sähköpostin. Sähköpostia ei lähetetty. |

```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.