AdminS32

ApiKeys7

Appointments21

AppointmentTypes10

BillableItems5

Breeds5

BulkClientExport2

BulkPatientExport2

CareQueue2

CaseMilestones6

Cases5

ChatExport1

ClientAppInvite3

ClientExport3

Clients5

ClinicConfig31

ClinicSettings2

Clocking6

Compliance1

ConsentDocuments2

DeaBooks9

DeaExport2

DiagnosisTerms1

DiscountCodes7

Drafts7

EdgePrinters3

EdgePrintJobs2

EmailVerification2

Erx6

Estimates25

ExamTemplates5

Expenses6

Featurebase2

FeatureFlags1

Flowboard10

GroupCodes5

GroupVisits6

Health1

HomeAgain4

IntegrationCredentials15

InternalPrescribing1

InternalWidget1

Inventory23

InventoryApprovals5

InventoryLocations7

Invoices24

JourneyMilestones6

Kiosk4

LabPanels5

Labs19

LocationClosures4

Locations11

Logos7

MedicationRequests7

MentorMetrics5

Metrics31

NpsAnalytics3

OnlineBookingReadiness1

Partners6

PatientGroups9

PatientMasses6

PatientProblems4

PatientRecordExport3

Patients21

Payments18

PaymentTokens5

Pharmacies5

Phones2

PriceRules6

Printers6

PrintJobs4

PtoRequests6

PublicNps2

PublicPriceList5

PublicQuestionnaires2

PublicSmsConsent2

PurchaseOrders11

QiEvents9

QuestionnaireResponses6

Questionnaires10

RabiesTags10

RdvmPortal22

Recordings8

RecurringExpenses5

ReferralMessages2

Referrals20

Reminders14

Reports2

RetailItems11

Roles6

RoomDayAssignments3

RxGovernance26

SavedReports5

ScheduleItems10

ServiceCatalog5

Shifts5

ShiftSwaps8

SlotConfigurations6

SmsConsent9

Species5

Subscriptions8

SurgicalRecords8

TagAssignments4

Tags5

TelnyxCallControl1

Templates10

TenantKnowledge4

TimeEntries5

Transparency3

Users13

Vaccinations9

VaccineAdministration3

VaccineCertificateRecords6

VaccineCertificates2

VaccineTypes5

Vendors6

Vitals2

VitalTypes6

Widget18

WidgetChatbot4

WorkItemRules5

WorkTasks13

ScheduleItems

Update a single instance of a recurring schedule item. Creates an exception record that overrides the specific occurrence.

put/ScheduleItems/{id}/instance

Path parameters

idstring required

Request body

originalStartTimestring date-time required

titlestring nullable

startTimestring date-time nullable

endTimestring date-time nullable

descriptionstring nullable

locationIdstring nullable

assignedToIdstring nullable

isCancelledboolean

Response

idstring

titlestring

startTimestring date-time

endTimestring date-time

descriptionstring nullable

typestring

locationIdstring

assignedToIdstring nullable

customAttributesstring nullable

createdAtstring date-time

updatedAtstring date-time

createdByIdstring nullable

createdBySourcestring nullable

hasAppointmentboolean

isRecurringboolean

recurrenceRulestring nullable

recurrenceEndDatestring date-time nullable

isExceptionboolean

parentScheduleItemIdstring nullable

isRecurrenceInstanceboolean

originalStartTimestring date-time nullable

Example response

{
  "appointment": {
    "patient": {
      "species": "Cat",
      "breed": "Siamese",
      "sex": "Male"
    }
  }
}

Changes

Changed in 1 of the 5 revisions of this API.30

Aug 7, 2026a905bde4e79630See the full diff
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/isTravelAppointment to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/isTravelAppointment to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/isTravelAppointment to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelAccessNotes to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelAccessNotes to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelAccessNotes to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDestinationAddress to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDestinationAddress to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDestinationAddress to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDestinationPlaceId to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDestinationPlaceId to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDestinationPlaceId to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDistanceMeters to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDistanceMeters to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDistanceMeters to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDurationMinutes to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDurationMinutes to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelDurationMinutes to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelFeeAmount to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelFeeAmount to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelFeeAmount to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelIsRoundTrip to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelIsRoundTrip to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelIsRoundTrip to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelStartingAddress to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelStartingAddress to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelStartingAddress to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelStartingPlaceId to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelStartingPlaceId to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property appointment/oneOf[AppointmentSummaryForScheduleDto]/travelStartingPlaceId to the response with the 200 status (media type: text/json)
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history