Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Appointments

Update an Appointment

Permissions needed: EDIT_APPOINTMENTS Update a singular a appointment. Cant do partial updates of resource

put/api/v1/appointments/{id}

Query parameters

includestring

Additional info to include. You can use multiple, comma separated. Options: patient,patient.species,patient.breed,patient.crossBreed,patient.owners,patient.owners.appDownloadNotification,patient.owners.clients,room,event, clinic,clinic.rooms,vet,vet.vetRolesAll,requests,notes,visitType

Parameters

#/paths/~1api~1v1~1sales/delete/parameters/0 — unresolved $ref

Request body

clinic_idinteger

Clinic Id.

vet_idinteger

Vet Id.

patient_idinteger

Pet id

visit_type_idinteger

Id of the VisitType

datetime_start_utcstring

Start Date in UTC ISO Zulu format

datetime_end_utcstring

End Date in UTC ISO Zulu format

observationsstring

Observations

status1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

1 - Pending Client Approval 2 - Pending Clinic Approval 3 - Rescheduled Clinic Approval 4 - Rescheduled Client Approval 5 - Confirmed 6 - Canceled By Client 7 - Canceled By Clinic' 8 - Automatically Created' 9 - No Show

notification_messagestring

Notification message

reminder_notificationsItems[] — unresolved $ref

Reminder notifications

record_idinteger nullable

Record ID - set null if not used

room_idinteger nullable

Room ID - set null if not used

examination_idinteger nullable

Examination ID - set null if not used

printable_file_idsinteger[]

Consent forms

video_linkstring nullable

Video link

user_notestring

Notes introduced by the pet parent

recurrencestring nullable

recurrence defined by RFC 5545

recurrence_update_mode'this' | 'this_and_following' | 'all'

Recurrence update mode

requires_payment_depositboolean

Example request

{
  "clinic_id": 1,
  "vet_id": 1,
  "patient_id": 1,
  "visit_type_id": 1,
  "datetime_start_utc": "2022-06-16T13:42:38Z",
  "datetime_end_utc": "2022-06-16T14:42:38Z",
  "status": 1,
  "reminder_notifications": [
    {
      "id": 1,
      "period": 1,
      "periodType": 0,
      "notificationType": 0
    },
    {
      "id": 2,
      "period": 1,
      "periodType": 1,
      "notificationType": 0
    }
  ],
  "printable_file_ids": [
    1,
    2
  ],
  "user_note": "Daisy has not been feeling well",
  "recurrence": "FREQ=DAILY;COUNT=10",
  "drop_off": {
    "time": "09:00",
    "vet_id": 1
  }
}

Response

successful operation

dataData — unresolved $ref