Add Panels

PATCH

api

home-kit-orders

{id}

panels

curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/panels \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "panel_ids": [
      "d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9",
      "e5f6a7b8-c9d0-4e2f-b3a4-c5d6e7f8a9b0"
    ]
  }'

{
  "success": true
}

{
  "error": "Panel not found"
}

Add one or more catalog panels to an existing home kit order. This endpoint is idempotent — already-attached panels are kept. You can call it multiple times to build up the panel selection.

Requires home_kit_orders_manage scope.

Panels can only be added while the kit is pending. Once the kit is dispatched its composition is locked and this call returns 409 Conflict — the physical kit ships with a fixed number of tubes derived from the selected panels and biomarkers, so its contents can’t change after it has been sent. activated and cancelled kits are likewise locked. If you need to change the tests on a locked kit, reach out to Aniva directly — it’s usually still possible, and we’ll make the change for you to keep the kit’s contents consistent.

Request

Path parameters

string

required

Unique identifier (UUID) of the home kit order to add panels to.

Body parameters

string[]

required

Array of panel UUIDs to add to the home kit order. Must contain at least one item.

Response

On success, the API returns 200 OK confirming the panels have been added.

boolean

true when the panels have been successfully added to the home kit order.

Error responses

Status	Description
`400`	Validation error — e.g., `panel_ids` is empty or contains an invalid UUID.
`403`	Forbidden — your API key does not have access to this operation.
`404`	Home kit order or one or more panels not found.
`409`	Conflict — the kit is `dispatched`, `activated`, or `cancelled`; its panel and biomarker composition is locked and can no longer change.
`500`	Internal server error.

curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/panels \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "panel_ids": [
      "d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9",
      "e5f6a7b8-c9d0-4e2f-b3a4-c5d6e7f8a9b0"
    ]
  }'

{
  "success": true
}

{
  "error": "Panel not found"
}

Cancel Home Kit Order

Remove Panels

curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/panels \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "panel_ids": [
      "d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9",
      "e5f6a7b8-c9d0-4e2f-b3a4-c5d6e7f8a9b0"
    ]
  }'

{
  "success": true
}

{
  "error": "Panel not found"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Request

Path parameters

Body parameters

Response

Error responses

​Request

​Path parameters

​Body parameters

​Response

​Error responses

Request

Path parameters

Body parameters

Response

Error responses