Update

PATCH

/:tenantId/appointments/:id

Body

{
    "user_id": 1,
    "patient_id": 1,
    "start_date": "2024-03-30 12:15",
    "end_date": "2024-03-30 12:45",
    "note": "",
    "notify": 1,
    "status": 1,
    "appointment_type_id":"1",
    "visit_type": 0,
    "conflict_strategy": "strict",
    "is_walk_in_visit": false,
    "source": "medibulut",
    "external_id": "mdb-appointment-123"
}

Key	Type	Required	Description
user_id	integer	no	ID of the user associated with the appointment.
patient_id	integer	no	ID of the patient associated with the appointment.
start_date	string	no	The starting date and time of the appointment.
end_date	string	no	The ending date and time of the appointment.
note	string	no	Additional notes for the appointment.
notify	integer	no	Indicates if notifications are enabled. Sends notification SMS and emails to patients when enabled. 0: Disabled (default) 1: Enabled
status	integer	no	Status of the appointment. See appointment statuses 1: NO SHOW 2: ATTENDED 3: CANCELLED 4: WAITING 5: CONFIRMED
appointment_type_id	integer	no	ID indicating the type of appointment.
source	string	no	The source of the record.
external_id	string	no	External identifier of the record.
kind	integer	no	Appointment kind.
visit_type	integer	no	Visit type: 0 in-person, 1 online.
conflict_strategy	string	no	strict or force_create.
resource_id	integer	no	Resource assigned to the appointment.
recurrence_rule	object	no	Recurrence definition; child recurrence records cannot define a new rule. Use exactly one of ends_at or count.
is_walk_in_visit	boolean	no	Marks the appointment as a walk-in visit.

Response

HTTP 200 OK

{
  "data": {
    "id": 1,
    "start_date": "2024-03-30T12:15:00.000000Z",
    "end_date": "2024-03-30T12:45:00.000000Z",
    "note": null,
    "user": {
      "id": 1,
      "name": "John Doe",
      "photo": null,
      "color": "#abcdef"
    },
    "appointment_type_id": 1,
    "status": 1,
    "notify": 1,
    "resource_id": null,
    "kind": 0,
    "visit_type": 0,
    "online_meeting": null,
    "source": "medibulut",
    "parent_id": null,
    "has_children_recurrences": false,
    "is_walk_in_visit": false
  }
}

HTTP 422 Unprocessable Content

{
  "message": "Must specify a valid user (and 1 more error)",
  "errors": {
    "user_id": [
      "Must specify a valid user"
    ],
    "patient_id": [
      "The selected patient id is invalid."
    ]
  }
}