PATCH
/
v3
/
order
/
{order_id}
/
phlebotomy
/
appointment
/
cancel
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
}

Authorizations

x-vital-api-key
string
headerrequired

Vital Team API Key

Path Parameters

order_id
string
required

Your Order ID.

Body

application/json
cancellation_reason_id
string
required
notes
string

Response

200 - application/json
id
string
required
user_id
string
required
order_id
string
required
address
object
required
location
object
required
start_at
string

Time is in UTC

end_at
string

Time is in UTC

iana_timezone
string
type
enum<string>
required

An enumeration.

Available options:
phlebotomy
provider
enum<string>
required

An enumeration.

Available options:
getlabs,
axlehealth,
phlebfinders
status
enum<string>
required

An enumeration.

Available options:
confirmed,
pending,
in_progress,
completed,
cancelled
provider_id
string
required
can_reschedule
boolean
required
event_status
enum<string>
required

An enumeration.

Available options:
pending,
scheduled,
completed,
cancelled,
in_progress
event_data
object
events
object[]
required