Appointment Availability1

Appointment Reminders3

Appointment Types2

Appointments5

Charges6

Deltas1

Drugs3

Encounter Types1

Encounters4

Extended Patient Details1

Facilities1

Health Maintenance2

Inventory4

Partner Applications3

Patient Allergies1

Patient Charges3

Patient Documents5

Patient Emails1

Patient Facilities/Specialists7

Patient Free-Text Notes4

Patient Health Maintenance2

Patient Images5

Patient Invoices2

Patient Lab Results1

Patient Orders2

Patient Past Medical History1

Patient Portal4

Patient Prescriptions5

Patient Subscriptions2

Patient Supplements4

Patient Tags3

Patient Vaccines1

Patient Vitals8

Patients6

Questionnaires3

Secure Messages2

Supplements5

Tags4

Tasks4

Users3

Vitals3

Appointment Reminders

Create an email reminder

Create an email reminder for an appointment

post/appointments/{appointment_id}/reminders/email

Request

Base URL: https://clinic-subdomain.md-hq.com/api/v1
URL: https://clinic-subdomain.md-hq.com/api/v1/appointments/{appointment_id}/reminders/email
Auth: HTTP basic

Path parameters

appointment_idinteger required

ID of the appointment

Request body

scheduled_datetimestring required

Datetime for the reminder to be sent. This field should be formatted as YYYY-MM-DD HH:MM.

subjectstring required

Subject for the reminder email.

textstring required

Body of the reminder email.

Example request

{
  "scheduled_datetime": "2020-01-01 09:00",
  "subject": "Reminder of your upcoming appointment"
}

Response

Changes

No recorded changes to this operation across all 1 revision of this API.