Detach Appointments from Shipment

DELETE

api

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 returns 200 OK with the full appointment list for the shipment, oldest-link first. Each entry has the same shape as Get Appointment. Mirror of Detach Shipments from Appointment, which returns the post-mutation shipment list for the parent appointment.

Error responses

Status	Description
`400`	Validation error — e.g., empty `appointment_ids` or invalid UUID.
`403`	Forbidden — missing scope, shipment outside access context, or appointment outside 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"
    ]
  }'

[]

Attach Appointments to Shipment

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"
    ]
  }'

[]

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Detach Appointments from Shipment

Request

Path parameters

Body parameters

Response

Error responses

​Request

​Path parameters

​Body parameters

​Response

​Error responses

Request

Path parameters

Body parameters

Response

Error responses