PATCH
/
appointments
/
{id}
curl --request PATCH \
  --url https://api.usecobalt.com/v1/appointments/{id} \
  --header 'Content-Type: application/json' \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>' \
  --data '{
  "mrn": "<string>",
  "location": "<string>",
  "datetime": "<string>",
  "provider": "<string>",
  "type": "<string>",
  "note": "<string>",
  "reason": "<string>"
}'
{
  "success": true,
  "message": "<string>"
}

The update process differs based on the current status of the appointment:

​
1. Updating Pending or Failed Appointments

For appointments with a status of ‘pending’ or ‘failed’, you can update any attribute of the appointment.

ParameterTypeRequiredDescription
Any appointment attributevariesNoAny attribute of the appointment can be updated. All fields are optional.

​
2. Updating Scheduled Appointments

For appointments with a status of ‘scheduled’, you can only update the status or note property.

ParameterTypeRequiredDescription
statusstringNoMust be one of the available statuses associated with the linked account. You can find the available statuses by using our GET /visit-statuses endpoint
notestringNoA note associated with the appointment. This is not a progress note or addition to the patient chart. This is primarily used for admin (eg. “patient might be 5 minutes late”).

​
Example Request for Updating a Pending/Failed Appointment

curl -X PATCH https://api.usecobalt.com/v1/appointments/23456789 \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-d '{
    "appointment_datetime": "2024-01-15T14:00:00-07:00",
    "location": "New Clinic",
    "type": "f/u"
}'

​
Example Response

{
    "success": true,
    "message": "Appointment updated successfully"
}

Authorizations

​
client_id
string
header
required
​
client_secret
string
header
required
​
access_token
string
header
required

Path Parameters

​
id
string
required

The appointment ID

Body

application/json

Updates for pending/failed appointments

Response

200 - application/json

Successful response

The response is of type object.