Add Panels

POST

api

appointments

{id}

panels

curl --request POST \
  --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",
      "e5f6a7b8-c9d0-4e2f-b3a4-c5d6e7f8a9b0"
    ]
  }'

{
  "success": true
}

{
  "error": "Panels cannot be added after the blood draw has been confirmed"
}

{
  "error": "Panel not found"
}

Add one or more blood test panels to an existing appointment. You can call this endpoint multiple times to build up the panel selection before confirming the blood draw.

Panels cannot be added after you call Confirm Blood Draw. Attempting to add panels to a confirmed appointment returns 409 Conflict.

Request

Path parameters

string

required

Unique identifier (UUID) of the appointment to add panels to.

Body parameters

string[]

required

Array of panel UUIDs to add to the appointment. 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 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 or one or more panels not found.
`409`	Conflict — panels cannot be added after the blood draw has been confirmed.
`500`	Internal server error.

curl --request POST \
  --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",
      "e5f6a7b8-c9d0-4e2f-b3a4-c5d6e7f8a9b0"
    ]
  }'

{
  "success": true
}

{
  "error": "Panels cannot be added after the blood draw has been confirmed"
}

{
  "error": "Panel not found"
}

Cancel Appointment

Remove Panels

curl --request POST \
  --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",
      "e5f6a7b8-c9d0-4e2f-b3a4-c5d6e7f8a9b0"
    ]
  }'

{
  "success": true
}

{
  "error": "Panels cannot be added after the blood draw has been confirmed"
}

{
  "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