Skip to main content
DELETE
/
api
/
v1
/
appointments
/
{id}
curl --request DELETE \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a \
  --header 'x-api-key: YOUR_API_KEY'

{
  "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
  "scheduled_at": "2026-05-15T12:30:00+02:00",
  "status": "cancelled",
  "test_method": "practitioner",
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-10T12:00:00Z",
  "profile": {
    "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "handle": null,
    "first_name": "Maria",
    "last_name": "Schmidt",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "height": 168,
    "weight": 65,
    "language": "de",
    "created_at": "2026-04-01T09:14:32Z",
    "updated_at": null
  },
  "panels": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:50:00Z"
    }
  ],
  "shipments": []
}
Cancel an appointment by setting its status to cancelled. Only appointments that have not yet had their blood draw confirmed can be cancelled.
Appointments cannot be cancelled after the blood draw has been confirmed. Attempting to cancel an appointment that has already been confirmed, or one that is already cancelled, returns 409 Conflict.

​
Request

​
Path parameters

​
id
string
required
Unique identifier (UUID) of the appointment to cancel.

​
Response

On success, the API returns 200 OK with the cancelled appointment and its embedded profile.
​
id
string
required
Unique appointment identifier (UUID).
​
profile_id
string
required
UUID of the profile this appointment belongs to.
​
location_id
string
UUID of the test location. null for home kit appointments.
​
scheduled_at
string
Scheduled appointment datetime in ISO 8601 format, returned with the test location’s offset (e.g. 2026-05-15T12:30:00+02:00). May be null.
​
status
string
required
Appointment status. Will be cancelled after a successful cancellation.
​
test_method
string
Method used for the blood draw. One of practitioner or home. May be null.
​
created_at
string
required
ISO 8601 timestamp of when the appointment was created.
​
updated_at
string
ISO 8601 timestamp of the last update. May be null.
​
profile
object
required
The patient profile associated with this appointment.
​
panels
AppointmentPanel[]
required
Panels that were attached to this appointment before cancellation. Look up panel details (name, biomarkers) via List Panels.
​
shipments
AppointmentShipmentLink[]
required
Shipments that were linked to this appointment before cancellation. Each id cross-references with Get Shipment.

​
Error responses

StatusDescription
400Invalid ID format — the provided value is not a valid UUID.
403Forbidden — your API key does not have access to this operation or the appointment is outside your access context.
404Appointment not found.
409Appointment cannot be cancelled (blood draw already confirmed or already cancelled).
500Internal server error.
curl --request DELETE \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a \
  --header 'x-api-key: YOUR_API_KEY'

{
  "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
  "scheduled_at": "2026-05-15T12:30:00+02:00",
  "status": "cancelled",
  "test_method": "practitioner",
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-10T12:00:00Z",
  "profile": {
    "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "handle": null,
    "first_name": "Maria",
    "last_name": "Schmidt",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "height": 168,
    "weight": 65,
    "language": "de",
    "created_at": "2026-04-01T09:14:32Z",
    "updated_at": null
  },
  "panels": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:50:00Z"
    }
  ],
  "shipments": []
}