VEvetcove
Scheduler

Create an appointment

Creates a new appointment for a clinic patient. The appointment is created with an initial status of CLIENT_REQUESTED.

An appointment represents a scheduled visit for a clinic patient at a clinic, tracking its lifecycle from request through completion or cancellation.

post/ext/v2/appointments/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/appointments/
  • Auth
    HTTP bearer

Request body

calendar_idinteger required

The ID of the calendar this appointment belongs to.

client_idinteger required

The ID of the clinic client responsible for the appointment.

end_datetimestring date-time required

ISO 8601 formatted datetime for when the appointment ends.

kind_idinteger required

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

patient_idinteger required

The ID of the clinic patient this appointment is for.

reasonstring

The reason for this appointment.

resource_idinteger nullable

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

start_datetimestring date-time required

ISO 8601 formatted datetime for when the appointment starts.

Response

Created

calendar_idinteger required

The ID of the calendar this appointment belongs to.

cancelation_reason_otherstring nullable required

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

clinic_client_idinteger nullable required

The ID of the clinic client responsible for the appointment.

clinic_idinteger required

The ID of the clinic this appointment belongs to.

clinic_notesunknown required
clinic_patient_idinteger nullable required

The ID of the clinic patient this appointment is for.

createdstring date-time required

The datetime this object was created.

deletedstring date-time nullable required

The datetime this record was soft deleted.

dropoff_start_datetimestring date-time nullable required

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

end_datetimestring date-time nullable required

ISO 8601 formatted datetime for when the appointment ends.

followup_appointment_idsinteger[]

List of followup appointment IDs associated with this appointment.

idinteger required

The unique identifier for the appointment.

is_deletedboolean required

Whether this record is soft deleted or not.

kindstring nullable

The appointment kind (type of appointment).

kind_idinteger nullable

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

medical_record_idinteger nullable

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

modifiedstring date-time required

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

pickup_start_datetimestring date-time nullable required

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

reasonstring nullable required

The reason for this appointment.

resource_idinteger nullable required

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

resource_namestring nullable

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

room_idinteger nullable required

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

room_namestring nullable

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

start_datetimestring date-time nullable required

ISO 8601 formatted datetime for when the appointment starts.

status'CREATING' | 'CLIENT_CREATING' | 'UNSCHEDULED' | 'UNCONFIRMED' | 'CONFIRMED' | 'DROPPED_OFF' | 'CHECKED_IN' | 'IN_PROGRESS' | 'READY_TO_GO' | 'COMPLETED' | 'NO_SHOW' | 'CANCELED' | 'IMPORTED' | 'CLIENT_REQUESTED' required

Changes

No recorded changes to this operation across all 1 revision of this API.