Update an appointment

PUT

ext

appointments

{appointment_id}

curl --request PUT \
  --url https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancelation_reason": "PATIENT_SEEN_ELSEWHERE",
  "cancelation_reason_other": "<string>",
  "custom_message": "",
  "end_datetime": "2023-11-07T05:31:56Z",
  "resource_id": 123,
  "should_notify_client": false,
  "start_datetime": "2023-11-07T05:31:56Z",
  "status": "CONFIRMED"
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/"

payload = {
    "cancelation_reason": "PATIENT_SEEN_ELSEWHERE",
    "cancelation_reason_other": "<string>",
    "custom_message": "",
    "end_datetime": "2023-11-07T05:31:56Z",
    "resource_id": 123,
    "should_notify_client": False,
    "start_datetime": "2023-11-07T05:31:56Z",
    "status": "CONFIRMED"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cancelation_reason: 'PATIENT_SEEN_ELSEWHERE',
    cancelation_reason_other: '<string>',
    custom_message: '',
    end_datetime: '2023-11-07T05:31:56Z',
    resource_id: 123,
    should_notify_client: false,
    start_datetime: '2023-11-07T05:31:56Z',
    status: 'CONFIRMED'
  })
};

fetch('https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'cancelation_reason' => 'PATIENT_SEEN_ELSEWHERE',
    'cancelation_reason_other' => '<string>',
    'custom_message' => '',
    'end_datetime' => '2023-11-07T05:31:56Z',
    'resource_id' => 123,
    'should_notify_client' => false,
    'start_datetime' => '2023-11-07T05:31:56Z',
    'status' => 'CONFIRMED'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/"

	payload := strings.NewReader("{\n  \"cancelation_reason\": \"PATIENT_SEEN_ELSEWHERE\",\n  \"cancelation_reason_other\": \"<string>\",\n  \"custom_message\": \"\",\n  \"end_datetime\": \"2023-11-07T05:31:56Z\",\n  \"resource_id\": 123,\n  \"should_notify_client\": false,\n  \"start_datetime\": \"2023-11-07T05:31:56Z\",\n  \"status\": \"CONFIRMED\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancelation_reason\": \"PATIENT_SEEN_ELSEWHERE\",\n  \"cancelation_reason_other\": \"<string>\",\n  \"custom_message\": \"\",\n  \"end_datetime\": \"2023-11-07T05:31:56Z\",\n  \"resource_id\": 123,\n  \"should_notify_client\": false,\n  \"start_datetime\": \"2023-11-07T05:31:56Z\",\n  \"status\": \"CONFIRMED\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancelation_reason\": \"PATIENT_SEEN_ELSEWHERE\",\n  \"cancelation_reason_other\": \"<string>\",\n  \"custom_message\": \"\",\n  \"end_datetime\": \"2023-11-07T05:31:56Z\",\n  \"resource_id\": 123,\n  \"should_notify_client\": false,\n  \"start_datetime\": \"2023-11-07T05:31:56Z\",\n  \"status\": \"CONFIRMED\"\n}"

response = http.request(request)
puts response.read_body

{
  "alert_tags": [
    "CONTAGIOUS"
  ],
  "calendar_id": 123,
  "cancelation_reason": "PATIENT_SEEN_ELSEWHERE",
  "cancelation_reason_other": "<string>",
  "clinic_client_id": 123,
  "clinic_id": 123,
  "clinic_notes": "<unknown>",
  "clinic_patient_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "dropoff_start_datetime": "2023-11-07T05:31:56Z",
  "end_datetime": "2023-11-07T05:31:56Z",
  "id": 123,
  "is_deleted": true,
  "modified": "2023-11-07T05:31:56Z",
  "pickup_start_datetime": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "resource_id": 123,
  "room_id": 123,
  "start_datetime": "2023-11-07T05:31:56Z",
  "status": "CREATING",
  "followup_appointment_ids": [],
  "kind": "<string>",
  "kind_id": 123,
  "medical_record_id": 123,
  "resource_name": "<string>",
  "room_name": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

appointment_id

integer

required

The ID of the appointment to update

Body

application/json

Schema for the AppointmentUpdateExternalAPIController request body

cancelation_reason

enum<string> | null

Required when status is CANCELED or NO_SHOW. Canceled appointments use the clinic cancel list. No-show appointments must use NO_SHOW.

Available options:

PATIENT_SEEN_ELSEWHERE,

CONCERN_RESOLVED,

PENDING_RESCHEDULE,

NO_LONGER_NEEDED,

WILL_RESCHEDULE,

DOCTOR_UNAVAILABLE,

CLINIC_SCHEDULE_CHANGE,

CREATED_IN_ERROR,

DUPLICATE,

WRONG_PATIENT,

WRONG_DATE_OR_TIME,

UNKNOWN,

OTHER,

NO_SHOW

Example:

"PATIENT_SEEN_ELSEWHERE"

cancelation_reason_other

string | null

Optional explanation when cancelation_reason is OTHER. Not required. Rejected when sent with any other reason.

custom_message

string

default:""

Custom message to include in the client notification. Only used if should_notify_client is true.

end_datetime

string<date-time> | null

ISO 8601 formatted datetime for when the appointment ends. Must be provided together with start_datetime.

resource_id

integer | null

The ID of the calendar resource (provider/room) to assign to this appointment.

should_notify_client

boolean

default:false

Whether to send a notification to the client about this update.

start_datetime

string<date-time> | null

ISO 8601 formatted datetime for when the appointment starts. Must be provided together with end_datetime.

status

enum<string> | null

The status of the appointment

Available options:

CREATING,

CLIENT_CREATING,

UNSCHEDULED,

UNCONFIRMED,

CONFIRMED,

DROPPED_OFF,

CHECKED_IN,

IN_PROGRESS,

READY_TO_GO,

COMPLETED,

NO_SHOW,

CANCELED,

IMPORTED,

CLIENT_REQUESTED

Example:

"CONFIRMED"

Response

200 - application/json

Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.

Unlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.

alert_tags

(enum<string> | string)[]

required

Array of alert tags associated with this appointment.

Available options:

CONTAGIOUS

calendar_id

integer

required

The ID of the calendar this appointment belongs to.

cancelation_reason

required

The reason for cancelation or no-show, if applicable.

Available options:

PATIENT_SEEN_ELSEWHERE,

CONCERN_RESOLVED,

PENDING_RESCHEDULE,

NO_LONGER_NEEDED,

WILL_RESCHEDULE,

DOCTOR_UNAVAILABLE,

CLINIC_SCHEDULE_CHANGE,

CREATED_IN_ERROR,

DUPLICATE,

WRONG_PATIENT,

WRONG_DATE_OR_TIME,

UNKNOWN,

OTHER,

NO_SHOW

cancelation_reason_other

string | null

required

Free-text explanation of the cancelation, if one was provided.

clinic_client_id

integer | null

required

The ID of the clinic client responsible for the appointment.

clinic_id

integer

required

The ID of the clinic this appointment belongs to.

clinic_notes

any | null

required

JSON structured notes for clinic use.

clinic_patient_id

integer | null

required

The ID of the clinic patient this appointment is for.

created

string<date-time>

required

The datetime this object was created.

deleted

string<date-time> | null

required

The datetime this record was soft deleted.

dropoff_start_datetime

string<date-time> | null

required

ISO 8601 formatted datetime for when the patient should be dropped off.

end_datetime

string<date-time> | null

required

ISO 8601 formatted datetime for when the appointment ends.

integer

required

The unique identifier for the appointment.

is_deleted

boolean

required

Whether this record is soft deleted or not.

modified

string<date-time>

required

The datetime this object was last modified; changes to related entities will not update this field.

pickup_start_datetime

string<date-time> | null

required

ISO 8601 formatted datetime for when the patient should be picked up.

reason

string | null

required

The reason for this appointment.

resource_id

integer | null

required

The ID of the calendar resource (provider/room) assigned to handle this appointment.

room_id

integer | null

required

The ID of the room assigned to this appointment, if any.

start_datetime

string<date-time> | null

required

ISO 8601 formatted datetime for when the appointment starts.

status

enum<string>

required

The current status of the appointment.

Available options:

CREATING,

CLIENT_CREATING,

UNSCHEDULED,

UNCONFIRMED,

CONFIRMED,

DROPPED_OFF,

CHECKED_IN,

IN_PROGRESS,

READY_TO_GO,

COMPLETED,

NO_SHOW,

CANCELED,

IMPORTED,

CLIENT_REQUESTED

followup_appointment_ids

integer[]

List of followup appointment IDs associated with this appointment.

kind

string | null

The appointment kind (type of appointment).

kind_id

integer | null

The ID of the appointment kind (type of appointment).

medical_record_id

integer | null

The ID of the medical record associated with this appointment, if any.

resource_name

string | null

The name of the calendar resource (provider/room) assigned to handle this appointment.

room_name

string | null

The name of the room assigned to this appointment, if any.

⌘I

Update an appointment

curl --request PUT \
  --url https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancelation_reason": "PATIENT_SEEN_ELSEWHERE",
  "cancelation_reason_other": "<string>",
  "custom_message": "",
  "end_datetime": "2023-11-07T05:31:56Z",
  "resource_id": 123,
  "should_notify_client": false,
  "start_datetime": "2023-11-07T05:31:56Z",
  "status": "CONFIRMED"
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/"

payload = {
    "cancelation_reason": "PATIENT_SEEN_ELSEWHERE",
    "cancelation_reason_other": "<string>",
    "custom_message": "",
    "end_datetime": "2023-11-07T05:31:56Z",
    "resource_id": 123,
    "should_notify_client": False,
    "start_datetime": "2023-11-07T05:31:56Z",
    "status": "CONFIRMED"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cancelation_reason: 'PATIENT_SEEN_ELSEWHERE',
    cancelation_reason_other: '<string>',
    custom_message: '',
    end_datetime: '2023-11-07T05:31:56Z',
    resource_id: 123,
    should_notify_client: false,
    start_datetime: '2023-11-07T05:31:56Z',
    status: 'CONFIRMED'
  })
};

fetch('https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'cancelation_reason' => 'PATIENT_SEEN_ELSEWHERE',
    'cancelation_reason_other' => '<string>',
    'custom_message' => '',
    'end_datetime' => '2023-11-07T05:31:56Z',
    'resource_id' => 123,
    'should_notify_client' => false,
    'start_datetime' => '2023-11-07T05:31:56Z',
    'status' => 'CONFIRMED'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/"

	payload := strings.NewReader("{\n  \"cancelation_reason\": \"PATIENT_SEEN_ELSEWHERE\",\n  \"cancelation_reason_other\": \"<string>\",\n  \"custom_message\": \"\",\n  \"end_datetime\": \"2023-11-07T05:31:56Z\",\n  \"resource_id\": 123,\n  \"should_notify_client\": false,\n  \"start_datetime\": \"2023-11-07T05:31:56Z\",\n  \"status\": \"CONFIRMED\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancelation_reason\": \"PATIENT_SEEN_ELSEWHERE\",\n  \"cancelation_reason_other\": \"<string>\",\n  \"custom_message\": \"\",\n  \"end_datetime\": \"2023-11-07T05:31:56Z\",\n  \"resource_id\": 123,\n  \"should_notify_client\": false,\n  \"start_datetime\": \"2023-11-07T05:31:56Z\",\n  \"status\": \"CONFIRMED\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/appointments/{appointment_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancelation_reason\": \"PATIENT_SEEN_ELSEWHERE\",\n  \"cancelation_reason_other\": \"<string>\",\n  \"custom_message\": \"\",\n  \"end_datetime\": \"2023-11-07T05:31:56Z\",\n  \"resource_id\": 123,\n  \"should_notify_client\": false,\n  \"start_datetime\": \"2023-11-07T05:31:56Z\",\n  \"status\": \"CONFIRMED\"\n}"

response = http.request(request)
puts response.read_body

{
  "alert_tags": [
    "CONTAGIOUS"
  ],
  "calendar_id": 123,
  "cancelation_reason": "PATIENT_SEEN_ELSEWHERE",
  "cancelation_reason_other": "<string>",
  "clinic_client_id": 123,
  "clinic_id": 123,
  "clinic_notes": "<unknown>",
  "clinic_patient_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "dropoff_start_datetime": "2023-11-07T05:31:56Z",
  "end_datetime": "2023-11-07T05:31:56Z",
  "id": 123,
  "is_deleted": true,
  "modified": "2023-11-07T05:31:56Z",
  "pickup_start_datetime": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "resource_id": 123,
  "room_id": 123,
  "start_datetime": "2023-11-07T05:31:56Z",
  "status": "CREATING",
  "followup_appointment_ids": [],
  "kind": "<string>",
  "kind_id": 123,
  "medical_record_id": 123,
  "resource_name": "<string>",
  "room_name": "<string>"
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

Authorizations

Path Parameters

Body

Response