Skip to main content
POST
Send emails

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Body

application/json
from
string
required

Email sender prefix (becomes @accounts.maxcare.ai)

Example:

"notifications"

subject
string
required

Email subject line

Example:

"Your upcoming appointment on March 25"

html
string
required

Email body as raw HTML

Example:

"<h1>Appointment Reminder</h1><p>You have an appointment scheduled for March 25 at 10:00 AM.</p>"

emailType
string
required

Email type for categorization

Example:

"appointment_reminder"

patientIds
string[]

Patient IDs to send to

Example:
userIds
string[]

Staff user IDs to send to

Example:
scheduledAt
string

Schedule send time (ISO 8601)

Example:

"2026-03-25T10:00:00Z"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required