Lab Testing - At-home Phlebotomy
Cancel Phlebotomy Appointment
PATCH

/v3/order/{order_id}/phlebotomy/appointment/cancel

x-vital-api-key*
curl --request PATCH \
  --url https://api.tryvital.io/v3/order/{order_id}/phlebotomy/appointment/cancel \
  --header 'x-vital-api-key: <x-vital-api-key>' \
  --data '{
  "cancellation_reason_id": "<cancellation_reason_id>"
}'
curl --request PATCH \
     --url '{{BASE_URL}}/v3/order/413d7205-f8a9-42ed-aa4a-edb99e481ca0/phlebotomy/appointment/cancel' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}' \
     --data '
{
    "cancellation_reason_id": "7dfd7da5-ed6e-40bb-a7e4-c8003f0c10a9"
}
'
{
    "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0",
    "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227",
    "address": {
        "first_line": "West Lincoln Street",
        "second_line": "",
        "city": "Phoenix",
        "state": "AZ",
        "zip_code": "85004",
        "unit": "14"
    },
    "location": {
        "lng": -112.0772235,
        "lat": 33.4421912
    },
    "start_at": "2023-05-17T20:00:00+00:00",
    "end_at": "2023-05-17T22:00:00+00:00",
    "iana_timezone": "America/Phoenix",
    "type": "phlebotomy",
    "provider": "getlabs",
    "status": "cancelled",
    "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c",
    "can_reschedule": true
}

Path Parameters

order_idrequired
string

Your Order ID.

Body

cancellation_reason_idrequired
string

Cancellation Reason Id

notes
string

Notes

Response

idrequired
string

Id

user_idrequired
string

User Id

addressrequired
object

USAddress

locationrequired
object

LngLat

start_atrequired
string

Start At

end_atrequired
string

End At

iana_timezonerequired
string

Iana Timezone

typerequired
string

An enumeration.

Available options:
phlebotomy
providerrequired
string

An enumeration.

Available options:
getlabs
statusrequired
string

An enumeration.

Available options:
confirmed,
pending,
in_progress,
completed,
cancelled
provider_idrequired
string

Provider Id

can_reschedulerequired
boolean

Can Reschedule