{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-open-api-appointment-controller-appointment-update-model-schema.json",
  "title": "OpenApiAppointmentController.AppointmentUpdateModel",
  "description": "Appointment update REST model.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-appointment-api-openapi.yml#/components/schemas/OpenApiAppointmentController.AppointmentUpdateModel",
  "required": [
    "endDate",
    "providerId",
    "startDate"
  ],
  "type": "object",
  "properties": {
    "appointmentCancellationReasonId": {
      "description": "The appointment cancellation reason identifier.",
      "type": "string"
    },
    "appointmentStatusId": {
      "description": "The appointment status identifier. If left null it will be set to a default value which is Upcoming.",
      "type": "string"
    },
    "appointmentTypeId": {
      "description": "The appointment type identifier. If left null it will block off time for provider. If BlockOff time for\nprovider is to be created then PatientIds and ClientId should be null.",
      "type": "string"
    },
    "cancellationNote": {
      "description": "The cancellation note.",
      "type": "string"
    },
    "clientId": {
      "description": "The client identifier. It can be set only when AppointmentTypeId has value.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "ISO string representing the appointment end date in UTC. Must be greater than StartDate, in 5-minute increments, and no more than 24 hours after StartDate.",
      "type": "string"
    },
    "patientIds": {
      "description": "The patient ids. Requires clientId. It can be set only when AppointmentTypeId has value.",
      "type": "array",
      "items": {
        "format": "uuid",
        "type": "string"
      }
    },
    "providerId": {
      "description": "The provider identifier.",
      "type": "string"
    },
    "sendEmailNotification": {
      "description": "A value indicating whether to send email notification. The default value is false.",
      "type": "boolean"
    },
    "sendSmsNotification": {
      "description": "A value indicating whether to send SMS notification. The default value is false.",
      "type": "boolean"
    },
    "startDate": {
      "format": "date-time",
      "description": "The ISO string representing appointment start date. Start date is in UTC time zone. Must be\nin increments of 5 minutes.",
      "type": "string"
    },
    "visitReason": {
      "description": "The reason for a visit. This will be the initial complaint in the SOAP.",
      "type": "string"
    }
  }
}