Shipments
Detach Appointments from Shipment
Remove one or more appointments from a shipment
DELETE
/
api
/
v1
/
shipments
/
{id}
/
appointments
curl --request DELETE \
--url https://anivahealth.com/api/v1/shipments/P2604154821/appointments \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"appointment_ids": [
"c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a"
]
}'
[]
Remove one or more appointments from this shipment. Silently ignores appointments that are not
currently linked.
The mutation rule is the same as Attach Appointments to
Shipment: the link can be removed when EITHER
the appointment is past blood-draw, or the shipment was created less than 24 hours ago.
Request
Path parameters
string
required
Shipment reference ID (e.g.,
P2604154821).Body parameters
string[]
required
Array of appointment UUIDs to detach. Must contain at least one item.
Response
On success, the API returns200 OK with the linked appointments in your access context,
oldest-link first. Each entry has the same shape as Get Appointment.
Error responses
| Status | Description |
|---|---|
400 | Validation error — e.g., empty appointment_ids or invalid UUID. |
403 | Forbidden — missing scope, shipment or appointment outside access context, or a linked home-kit order is outside your access context. |
404 | Shipment not found, or one or more appointments not found. |
409 | Mutation rule failed — at least one appointment is not past blood-draw and the shipment is older than 24 hours. Response lists the IDs. |
500 | Internal server error. |
curl --request DELETE \
--url https://anivahealth.com/api/v1/shipments/P2604154821/appointments \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"appointment_ids": [
"c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a"
]
}'
[]
⌘I
curl --request DELETE \
--url https://anivahealth.com/api/v1/shipments/P2604154821/appointments \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"appointment_ids": [
"c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a"
]
}'
[]