API Endpoints

Complete reference for HealthTalk API endpoints.

Messages

Send Message


POST /v1/messages

Request Body:


{
  "patientId": "pat_123",
  "templateId": "tpl_456",
  "channel": "sms",
  "variables": {
    "appointmentDate": "2026-03-15",
    "appointmentTime": "10:30"
  }
}

Response:


{
  "id": "msg_789",
  "status": "queued",
  "createdAt": "2026-03-10T09:00:00Z"
}

Get Message Status


GET /v1/messages/{messageId}

List Messages


GET /v1/messages?patientId={patientId}&limit=20&offset=0

Patients

Get Patient


GET /v1/patients/{patientId}

Update Communication Preferences


PATCH /v1/patients/{patientId}/preferences

Templates

List Templates


GET /v1/templates

Get Template


GET /v1/templates/{templateId}

Appointments

List Appointments


GET /v1/appointments?from={date}&to={date}

Send Reminder


POST /v1/appointments/{appointmentId}/remind

Webhooks

List Webhook Subscriptions


GET /v1/webhooks

Create Webhook


POST /v1/webhooks

See Webhooks for detailed webhook documentation.