Remove Individual Biomarkers

DELETE

api

home-kit-orders

{id}

biomarkers

curl --request DELETE \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/biomarkers \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "biomarker_ids": [42]
  }'

{
  "success": true
}

{
  "error": "Biomarker not attached to this home kit order"
}

Remove one or more à-la-carte biomarkers from an existing home kit order. Removal is idempotent: biomarkers that are not attached are ignored rather than rejected. See Idempotency. Requires the home_kit_orders_manage scope plus the home_kit_orders_individual_biomarker_selection capability scope. Home kits are ordered by panel, so single markers are enabled per partner. Ask Aniva if your integration needs it.

Biomarkers can only be removed 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 remove biomarkers from.

Body parameters

integer[]

required

Array of biomarker identifiers to remove from the home kit order. Must contain at least one item.

Response

On success, the API returns 200 OK confirming the biomarkers have been removed.

boolean

true when the biomarkers have been successfully removed from the home kit order.

Error responses

Status	Description
`400`	Validation error — e.g., `biomarker_ids` is empty or contains an invalid value.
`403`	Forbidden — missing `home_kit_orders_manage` or the `home_kit_orders_individual_biomarker_selection` capability scope.
`404`	Home kit order 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 DELETE \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/biomarkers \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "biomarker_ids": [42]
  }'

{
  "success": true
}

{
  "error": "Biomarker not attached to this home kit order"
}

curl --request DELETE \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/biomarkers \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "biomarker_ids": [42]
  }'

{
  "success": true
}

{
  "error": "Biomarker not attached to this home kit order"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Remove Individual Biomarkers

Request

Path parameters

Body parameters

Response

Error responses

​Request

​Path parameters

​Body parameters

​Response

​Error responses

Request

Path parameters

Body parameters

Response

Error responses