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

# Thuistestkit-bestelling bijwerken

> Een thuistestkit per post wijzigen

Werk het bezorgadres, panel, de metadata of de e-mails voor beschikbare resultaten van een thuistestkitbestelling bij. Stuur alleen de velden mee die je wilt wijzigen.

Het bezorgadres en het panel kunnen alleen worden gewijzigd zolang de bestelling de status `pending` heeft, omdat de fysieke kit bij verzending wordt verstuurd. `metadata` is voor je eigen administratie en blijft tijdens de hele looptijd van de bestelling beschrijfbaar.

Er zijn geen endpoints om een panel toe te voegen of te verwijderen: een thuistestkit bevat precies één panel (het komt 1:1 overeen met een fysiek kitproduct), dus de enige zinvolle panelbewerking is het wisselen dat je hier doet.

Vereist de scope `home_kit_orders_manage`.

## Verzoek

### Padparameters

**id** `string` *required*

Unieke identifier (UUID) van de thuistestkitbestelling die je wilt bijwerken.

### Bodyparameters

Alle bodyparameters zijn optioneel — neem alleen de velden op die je wilt wijzigen.

**delivery\_address** `object`

Het adres waar de kit naartoe wordt gestuurd — in een van twee vormen: ofwel `{ location_id }` dat verwijst naar een bekende testlocatie, ofwel de inline adresvelden (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` optioneel — dezelfde veldnamen als in de locations API). Geef precies één optie mee — een locatieverwijzing of een inline adres, niet beide.

**bezorgadres**

> [tab] Verwijzen naar een locatie
>
> **location\_id** `string` *required*
>
> UUID van een bekende testlocatie waarnaar de kit wordt verzonden. Koppel met [Locaties
> weergeven](https://docs.anivahealth.com/nl/api/locations/list-locations.md).

> [tab] Inline adres
>
> **name** `string` *required*
>
> Naam van ontvanger, bedrijf of locatie.
>
> **company\_name** `string`
>
> Bedrijf dat het pakket voor de ontvanger in ontvangst neemt — een `c/o`-partij of een afdeling.
>
> **street** `string` *required*
>
> Straatnaam, zonder huisnummer (bijv. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Huisnummer (bijv. `118` of `12a`).
>
> **address\_line\_2** `string`
>
> Gebouw, ingang of verdieping.
>
> **city** `string` *required*
>
> **state** `string`
>
> Deelstaat of provincie. Optioneel.
>
> **postal\_code** `string` *required*
>
> Postcode. Een Duits adres (`country_code` `DE`) vereist precies 5 cijfers, bijv. `10117`.
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-code (twee letters, bijv. `DE`). Kleine letters worden geaccepteerd en opgeslagen als
> hoofdletters.
>
> **phone** `string`
>
> Telefoonnummer van de ontvanger, met landcode (bijv. `+4791234567`). De vervoerder gebruikt het om
> de ontvanger over het pakket te informeren, bijvoorbeeld dat het klaarligt bij een afhaalpunt. Laat
> je het weg, dan krijgt de vervoerder geen telefoonnummer.
>
> **email** `string`
>
> E-mailadres van de ontvanger. De vervoerder gebruikt het net als `phone`. Laat je het weg, dan krijgt de vervoerder geen
> e-mailadres.

> [!NOTE]
>
> **Packstation of Postfiliale (alleen Duitsland):** stel `street` in op `Packstation` of `Postfiliale`,
> `house_number` op het driecijferige stationsnummer en `address_line_2` op het
> DHL-Postnummer van de ontvanger (6–10 cijfers, spaties toegestaan). Zonder het Postnummer kan het pakket niet worden geboekt.
> Een Postfach wordt niet ondersteund.

**panel\_id** `string`

UUID van het panel dat je in plaats van het huidige wilt koppelen — met precies één panel per kit
is wisselen de enige zinvolle bewerking. Alleen zolang de bestelling de status `pending` heeft, en
alleen naar een panel waarvoor Aniva een fulfilment-kitproduct heeft geconfigureerd (anders `422`);
wisselen naar het reeds gekoppelde panel is een no-op.

**metadata** `object`

Je eigen sleutel-waardeparen. Wordt **samengevoegd** met de bestaande metadata in plaats van deze te
vervangen: sleutels die je weglaat blijven behouden, een sleutel met de waarde `null` wordt verwijderd
en een leeg object `{}` wist alles. De limieten komen overeen met
[Thuistestkitbestelling aanmaken](https://docs.anivahealth.com/nl/api/home-kit-orders/create-home-kit.md), en de validatie is alles-of-niets
— als één sleutel wordt afgewezen, wordt er niets weggeschreven. Zet nooit persoons- of klinische gegevens
in `metadata` — dit wordt niet als patiëntgegevens behandeld.

**results\_ready\_emails** `string[]`

Vervangt de lijst van maximaal 5 adressen die elk één e-mail krijgen zodra alle labresultaten
definitief zijn. Stuur `[]` om de e-mails uit te schakelen. Aanpasbaar bij elke status behalve
`cancelled`. Je sleutel heeft `results_view`-toegang tot de patiënt nodig, anders volgt `403`. Zie
[E-mails voor beschikbare resultaten](https://docs.anivahealth.com/nl/concepts/results.md#e-mails-zodra-resultaten-klaarstaan).

## Respons

Bij succes geeft de API `200 OK` terug met de bijgewerkte thuistestkitbestelling en het ingesloten profiel.

**id** `string` *required*

Unieke identifier (UUID) van de thuistestkitbestelling.

**profile\_id** `string` *required*

UUID van het profiel waarbij deze thuistestkitbestelling hoort.

**status** `string` *required*

Huidige status van de thuistestkitbestelling. Een van `pending`, `dispatched`, `activated` of `cancelled`.

**delivery\_address** `object` *required*

Het adres waar de kit naartoe wordt gestuurd — in een van twee vormen: ofwel `{ location_id }` dat verwijst naar een bekende testlocatie, ofwel de inline adresvelden (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` optioneel — dezelfde velden als de locations-API). Geef precies één vorm op — een locatieverwijzing of een inline adres, niet beide.

**bezorgadres**

> [tab] Locatieverwijzing
>
> **location\_id** `string` *required*
>
> UUID van de testlocatie waar de kit naartoe wordt verzonden.

> [tab] Inline adres
>
> **name** `string` *required*
>
> Naam van ontvanger, bedrijf of locatie.
>
> **company\_name** `string`
>
> Bedrijf dat het pakket voor de ontvanger in ontvangst neemt — een `c/o`-partij of een afdeling.
>
> **street** `string` *required*
>
> Straatnaam, zonder huisnummer (bijv. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Huisnummer (bijv. `118` of `12a`).
>
> **address\_line\_2** `string`
>
> Gebouw, ingang of verdieping.
>
> **city** `string` *required*
>
> **state** `string`
>
> Deelstaat of provincie. Optioneel.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-code (twee letters, bijv. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Monstercode van het laboratorium waaronder de resultaten worden gerapporteerd — afgedrukt op de fysieke kit, en wat de
patiënt van de doos afleest als activeringscode. `null` totdat de kit is verpakt.
Alleen-lezen.

**activated\_at** `string` *required*

Afnametijdstempel doorgegeven via [Activeren](https://docs.anivahealth.com/nl/api/home-kit-orders/activate-home-kit.md) — wanneer de
patiënt het monster heeft afgenomen. `null` totdat de kit is geactiveerd.

**replaces\_home\_kit\_order\_id** `string`

De thuistestkitbestelling die door deze bestelling wordt vervangen, als het een vervangende kit is. `null` bij een normale bestelling. Zie
[Thuistestkitbestelling aanmaken](https://docs.anivahealth.com/nl/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Waarom de vervangende kit is verstuurd. `null` bij een normale bestelling.

**results\_ready\_emails** `string[]` *required*

E-mailadressen die elk één e-mail krijgen zodra alle labresultaten definitief zijn, in kleine letters. Leeg wanneer uitgeschakeld. Zie
[E-mails bij beschikbare resultaten](https://docs.anivahealth.com/nl/concepts/results.md#e-mails-zodra-resultaten-klaarstaan).

**metadata** `object` *required*

Door de partner gedefinieerde sleutel-waardeparen, letterlijk teruggegeven. Altijd aanwezig — `{}` indien niet ingesteld.

**created\_at** `string` *required*

ISO 8601-tijdstempel waarop de thuistestkitbestelling is aangemaakt.

**updated\_at** `string`

ISO 8601-tijdstempel van de laatste update. Kan `null` zijn.

**profile** `object` *required*

Het patiëntprofiel dat bij deze thuistestkitbestelling hoort.

**profiel**

**id** `string`

Unieke profiel-identifier (UUID).

**handle** `string`

Profielhandle of gebruikersnaam. Kan `null` zijn.

**first\_name** `string`

Voornaam. Kan `null` zijn.

**last\_name** `string`

Achternaam. Kan `null` zijn.

**email** `string`

E-mailadres. Kan `null` zijn.

**phone** `string`

Telefoonnummer in E.164-formaat. Kan `null` zijn.

**sex** `integer`

Biologisch geslacht volgens ISO/IEC 5218. Kan `null` zijn.

**date\_of\_birth** `string`

Geboortedatum in `YYYY-MM-DD`-formaat. Kan `null` zijn.

**height** `number`

Lengte in centimeters. Kan `null` zijn.

**weight** `number`

Gewicht in kilogrammen. Kan `null` zijn.

**language** `string`

Voorkeurstaal: een van de 32 codes in [Profiel aanmaken](https://docs.anivahealth.com/nl/api/profiles/create-profile.md).

**transactional\_emails\_enabled** `boolean`

Of dit profiel transactionele (programmatische) e-mails ontvangt. Kan `null` zijn.

**created\_at** `string`

ISO 8601-tijdstempel van wanneer het profiel is aangemaakt.

**updated\_at** `string`

ISO 8601-tijdstempel van de laatste profielupdate. Kan `null` zijn.

**panels** `HomeKitOrderPanel[]` *required*

Het panel dat aan deze thuistestkitbestelling is gekoppeld — altijd precies één (een thuistestkit
komt 1:1 overeen met een fysiek kitproduct) en wordt direct vervangen wanneer je `panel_id` meestuurt.
Zoek paneldetails (naam, biomarkers) op via [Panels ophalen](https://docs.anivahealth.com/nl/api/panels/list-panels.md).

**Velden voor panelkoppeling**

**panel\_id** `string`

Panel-UUID — op te zoeken via [Panels ophalen](https://docs.anivahealth.com/nl/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tijdstempel waarop het panel voor het eerst aan deze thuistestkitbestelling is gekoppeld.

**individual\_biomarkers** `HomeKitOrderIndividualBiomarker[]` *required*

Losse biomarkers die buiten een panel aan deze thuistestkitbestelling zijn gekoppeld. Vergelijk elke
`biomarker_id` met [Biomarkers weergeven](https://docs.anivahealth.com/nl/api/biomarkers/list-biomarkers.md) met `home_kit=true` voor weergavegegevens.

**Velden voor losse biomarkers**

**biomarker\_id** `integer`

Biomarker-identifier — op te zoeken via
[Biomarkers ophalen](https://docs.anivahealth.com/nl/api/biomarkers/list-biomarkers.md) met `home_kit=true`.

**added\_at** `string`

ISO 8601-tijdstempel waarop de biomarker voor het eerst aan deze thuistestkitbestelling is gekoppeld.

**shipments** `HomeKitOrderShipmentLink[]` *required*

Pakketten die aan deze thuistestkitbestelling zijn gekoppeld, oudste koppeling eerst — normaal gesproken de kit naar de patiënt
en het monster terug naar het laboratorium. Leeg totdat fulfilment een label afdrukt. Lees de
volledige pakketgegevens met [Zendingen weergeven](https://docs.anivahealth.com/nl/api/shipments/list-shipments.md) en `?home_kit_order_id=`.

**Velden voor zendingskoppeling**

**id** `string`

Zendingsreferentie — op te zoeken via [Zending ophalen](https://docs.anivahealth.com/nl/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tijdstempel waarop de zending aan deze thuistestkitbestelling is gekoppeld.

## Foutresponsen

| Status | Beschrijving |
| - | - |
| `400` | Validatiefout — bijv. ongeldige UUID-indeling of een ontbrekend veld in `delivery_address`. |
| `403` | Geen toegang — je API-sleutel heeft geen toegang tot deze bewerking, de thuistestkitbestelling valt buiten je toegangsbereik, of je hebt `results_ready_emails` ingesteld zonder `results_view`-toegang tot de patiënt. |
| `404` | Thuistestkitbestelling niet gevonden, of het panel van `panel_id` bestaat niet. |
| `409` | Conflict — de bestelling heeft niet langer de status `pending`; adres en panel kunnen alleen vóór verzending worden gewijzigd. |
| `409` | Conflict — de bestelling is een vervangende kit en behoudt het panel van de bestelling die wordt vervangen. |
| `409` | Conflict — de bestelling heeft de status `cancelled` en je hebt `results_ready_emails` meegestuurd. |
| `422` | Het panel is niet als thuistestkit te bestellen — er is geen fulfilment-kitproduct geconfigureerd. |
| `500` | Interne serverfout. |

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Unter den Linden",
      "house_number": "77",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    }
  }'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "pending",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Unter den Linden",
    "house_number": "77",
    "postal_code": "10117",
    "city": "Berlin",
    "country_code": "DE",
    "phone": "+4930123456789",
    "email": "maria.schmidt@example.com"
  },
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-01T13:10:00Z",
  "profile": {
    "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "handle": null,
    "first_name": "Maria",
    "last_name": "Schmidt",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "created_at": "2026-04-01T09:14:32Z",
    "updated_at": null
  },
  "panels": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:50:00Z"
    }
  ],
  "individual_biomarkers": [],
  "metadata": { "your_order_ref": "ORD-10482" },
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 400 theme={null}
{
  "error": "delivery_address: Invalid input"
}
```

```json 409 theme={null}
{
  "error": "Panels and biomarkers can only be changed while the home kit order is pending. Once it is dispatched, activated, or cancelled its composition is locked."
}
```

```json 404 theme={null}
{
  "error": "Home kit order not found"
}
```


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