Appointments
Remove Panels
Remove blood test panels from an appointment
DELETE
/
api
/
v1
/
appointments
/
{id}
/
panels
curl --request DELETE \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/panels \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"panel_ids": [
"d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9"
]
}'
{
"success": true
}
{
"error": "Panels cannot be removed after blood draw has been confirmed"
}
{
"error": "Appointment not found"
}
Remove one or more blood test panels from an existing appointment. This deletes the planned test snapshots associated with the specified panels.
Removal is idempotent: panels that are not attached are ignored rather than rejected. See Idempotency.
Requires the
At a pharmacy location (capillary draw), the individual biomarkers are packed into microtainers
with the panels. If the remaining set breaks the 150 µl rule of
Add Individual Biomarkers, the call returns
test_sessions_schedule or test_sessions_manage scope.
Panels cannot be removed after you call Confirm Blood
Draw. Attempting to remove panels from a confirmed
appointment returns
409 Conflict.400
with an error message and no panel is removed.
Request
Path parameters
string
required
Unique identifier (UUID) of the appointment to remove panels from.
Body parameters
string[]
required
Array of panel UUIDs to remove from the appointment. Must contain at least one item. A panel that
is not attached is ignored.
Response
On success, the API returns200 OK confirming the panels have been removed.
boolean
true when the panels have been successfully removed from the appointment.Error responses
| Status | Description |
|---|---|
400 | Validation error — e.g., panel_ids is empty or contains an invalid UUID — or, at a pharmacy, the individual biomarkers no longer fit in their microtainers. |
403 | Forbidden — your API key does not have access to this operation. |
404 | Appointment not found. |
409 | Conflict — panels cannot be removed 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/panels \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"panel_ids": [
"d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9"
]
}'
{
"success": true
}
{
"error": "Panels cannot be removed after blood draw has been confirmed"
}
{
"error": "Appointment not found"
}
⌘I
curl --request DELETE \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/panels \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"panel_ids": [
"d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9"
]
}'
{
"success": true
}
{
"error": "Panels cannot be removed after blood draw has been confirmed"
}
{
"error": "Appointment not found"
}