Sign in

v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
ScheduleItems

Create a new standalone schedule item (non-appointment)

post/ScheduleItems

Request body

titlestring required
startTimestring date-time required
endTimestring date-time required
descriptionstring nullable
typestring required
locationIdstring required
assignedToIdstring nullable
customAttributesstring nullable
isRecurringboolean

Response

OK

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"
    }
  }
}