Remove Panels

DELETE

api

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": "Panels not associated with this appointment: d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9"
}

Remove one or more blood test panels from an existing appointment. This deletes the planned test snapshots associated with the specified panels.

Panels cannot be removed after you call Confirm Blood Draw. Attempting to remove panels from a confirmed appointment returns 409 Conflict.

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. All panels must currently be associated with the appointment.

Response

On success, the API returns 200 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.
`403`	Forbidden — your API key does not have access to this operation.
`404`	Appointment not found, or one or more panels are not associated with the appointment.
`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": "Panels not associated with this appointment: d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9"
}

Add Panels

Add Individual Biomarkers

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": "Panels not associated with this appointment: d4e5f6a7-b8c9-4d1e-a2f3-b4c5d6e7f8a9"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Remove Panels

Request

Path parameters

Body parameters

Response

Error responses

​Request

​Path parameters

​Body parameters

​Response

​Error responses

Request

Path parameters

Body parameters

Response

Error responses