Skip to content

Update

PATCH

/:tenantId/appointments/:id

Body

json
{
    "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",
    "source": "medibulut",
    "external_id": "mdb-appointment-123"
}
KeyTypeRequiredDescription
user_idintegernoID of the user associated with the appointment.
patient_idintegernoID of the patient associated with the appointment.
start_datestringnoThe starting date and time of the appointment.
end_datestringnoThe ending date and time of the appointment.
notestringnoAdditional notes for the appointment.
notifyintegernoIndicates if notifications are enabled. Sends notification SMS and emails to patients when enabled.
0: Disabled (default)
1: Enabled
statusintegernoStatus of the appointment. See appointment statuses
1: NO SHOW
2: ATTENDED
3: CANCELLED
4: WAITING
5: CONFIRMED
appointment_type_idintegernoID indicating the type of appointment.
sourcestringnoThe source of the record.
external_idstringnoExternal identifier of the record.

Response

HTTP 200 OK

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

HTTP 422 Unprocessable Content

json
{
  "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."
    ]
  }
}