Appointments
Remove Individual Biomarkers
Remove individual biomarkers from an appointment
DELETE
/
api
/
v1
/
appointments
/
{id}
/
biomarkers
curl --request DELETE \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/biomarkers \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"biomarker_ids": [42]
}'
{
"success": true
}
{
"error": "Appointment not found"
}
Remove one or more individual biomarkers from an appointment’s à-la-carte set.
The post-removal biomarker set is validated against each lab’s closure rules: a removal can
strand the set (e.g. dropping LDL while keeping the LDL/HDL ratio). When it does, the request
returns
400 with structured recovery options and nothing is removed. See Add Individual
Biomarkers for the shape of the validation
payload.
Removal is idempotent: biomarkers that are not attached are ignored rather than rejected. See Idempotency.
Requires the test_sessions_schedule or test_sessions_manage scope, plus schedule_appointments_with_individual_biomarker_selection.
Biomarkers cannot be removed after you call Confirm Blood
Draw.
Request
Path parameters
string
required
Unique identifier (UUID) of the appointment.
Body parameters
number[]
required
Array of biomarker IDs to detach. Must contain at least one item. An ID that is not on the
appointment is ignored.
Response
boolean
true when the biomarkers have been successfully removed.Error responses
Removal never returnsbiomarker_not_priced. The price of a marker does not depend on the rest of
the set. A set that already holds an unpriced marker stays editable. See Add Individual
Biomarkers.
| Status | Description |
|---|---|
400 | biomarker_ids empty / non-integer, the post-removal set fails closure validation (validation.failures), or the removal would strand a biomarker sold only inside a position (error: "biomarker_requires_position"). |
403 | Forbidden — missing scope or appointment outside access context. |
404 | Appointment not found. |
409 | Conflict — biomarkers cannot be modified after the blood draw has been confirmed. |
500 | Internal server error. |
curl --request DELETE \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/biomarkers \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"biomarker_ids": [42]
}'
{
"success": true
}
{
"error": "Appointment not found"
}
⌘I
curl --request DELETE \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/biomarkers \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"biomarker_ids": [42]
}'
{
"success": true
}
{
"error": "Appointment not found"
}