Medsender Developer Portal

Send a secure email link for a document. Useful when you want recipients to access PHI via a time-limited link.

Send Secure Link

POST /emails — Sends a secure email link for a document.

Request Parameters (multipart form data)

Parameter	Required	Description
file	Yes	PDF or TIFF document to share
recipient_email	Yes	Email address of the recipient
recipient_name	No	Name of the recipient (displayed in email)
sender_name	No	Name of the sender (displayed in email)
reply_to_email	No	Reply-to email address
subject	No	Email subject line
note	No	Internal note for your reference
patient_name	No	Patient name for record keeping
patient_dob	No	Patient date of birth (YYYY-MM-DD)
expire_after	No	Days until link expires (1-180, default 30)
callback_url	No	URL to receive status callback

export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -X POST -H "Authorization: Bearer $API_KEY" \
  -F "file=@./sample.pdf" \
  -F "recipient_email=recipient@example.com" \
  -F "recipient_name=Recipient" \
  -F "sender_name=Sender" \
  -F "subject=Secure Link" \
  -F "note=Referral" \
  -F "expire_after=30" \
  -F "callback_url=https://example.com/webhooks/email" \
  "$API_BASE/emails"

bash

export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -X POST -H "Authorization: Bearer $API_KEY" \
  -F "file=@./sample.pdf" \
  -F "recipient_email=recipient@example.com" \
  -F "recipient_name=Recipient" \
  -F "sender_name=Sender" \
  -F "subject=Secure Link" \
  -F "note=Referral" \
  -F "expire_after=30" \
  -F "callback_url=https://example.com/webhooks/email" \
  "$API_BASE/emails"

export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -X POST -H "Authorization: Bearer $API_KEY" \
  -F "file=@./sample.pdf" \
  -F "recipient_email=recipient@example.com" \
  -F "recipient_name=Recipient" \
  -F "sender_name=Sender" \
  -F "subject=Secure Link" \
  -F "note=Referral" \
  -F "expire_after=30" \
  -F "callback_url=https://example.com/webhooks/email" \
  "$API_BASE/emails"

Response

{
  "message": "Record has been sent, we will send a callback upon completion.",
  "email_id": "e5f6a7b8c9d0"
}

JSON

{
  "message": "Record has been sent, we will send a callback upon completion.",
  "email_id": "e5f6a7b8c9d0"
}

{
  "message": "Record has been sent, we will send a callback upon completion.",
  "email_id": "e5f6a7b8c9d0"
}

Get Email

GET /emails/:id — Retrieves details for a specific secure link email.

The :id parameter is the email_id returned when you created the email.

curl -s -H "Authorization: Bearer sk_test_..." "https://api.medsender.com/api/v2/emails/REPLACE_EMAIL_ID" | jq

bash

curl -s -H "Authorization: Bearer sk_test_..." "https://api.medsender.com/api/v2/emails/REPLACE_EMAIL_ID" | jq

curl -s -H "Authorization: Bearer sk_test_..." "https://api.medsender.com/api/v2/emails/REPLACE_EMAIL_ID" | jq

Response

{
  "sender_name": "Example Provider",
  "recipient_email": "recipient@example.com",
  "recipient_name": "Dr. Example",
  "reply_to_email": null,
  "patient_name": "John Doe",
  "patient_dob": "1990-01-15",
  "record_status": "activated",
  "email_status": "success",
  "email_id": "e5f6a7b8c9d0",
  "secure_link": "https://records.medsender.com/...",
  "expiry": "2025-02-15T10:00:00.000Z",
  "sent_at": "2025-01-15T10:00:00.000Z",
  "note": "Referral documents",
  "subject": "Secure Medical Documents",
  "last_viewed_at": null,
  "is_test": false,
  "error_details": {
    "error_code": null,
    "error_details": null
  }
}

JSON

{
  "sender_name": "Example Provider",
  "recipient_email": "recipient@example.com",
  "recipient_name": "Dr. Example",
  "reply_to_email": null,
  "patient_name": "John Doe",
  "patient_dob": "1990-01-15",
  "record_status": "activated",
  "email_status": "success",
  "email_id": "e5f6a7b8c9d0",
  "secure_link": "https://records.medsender.com/...",
  "expiry": "2025-02-15T10:00:00.000Z",
  "sent_at": "2025-01-15T10:00:00.000Z",
  "note": "Referral documents",
  "subject": "Secure Medical Documents",
  "last_viewed_at": null,
  "is_test": false,
  "error_details": {
    "error_code": null,
    "error_details": null
  }
}

{
  "sender_name": "Example Provider",
  "recipient_email": "recipient@example.com",
  "recipient_name": "Dr. Example",
  "reply_to_email": null,
  "patient_name": "John Doe",
  "patient_dob": "1990-01-15",
  "record_status": "activated",
  "email_status": "success",
  "email_id": "e5f6a7b8c9d0",
  "secure_link": "https://records.medsender.com/...",
  "expiry": "2025-02-15T10:00:00.000Z",
  "sent_at": "2025-01-15T10:00:00.000Z",
  "note": "Referral documents",
  "subject": "Secure Medical Documents",
  "last_viewed_at": null,
  "is_test": false,
  "error_details": {
    "error_code": null,
    "error_details": null
  }
}

Response Fields

Field	Description
email_id	Unique identifier for this email (use to retrieve status)
recipient_email	Email address the link was sent to
recipient_name	Recipient name if provided
sender_name	Sender name if provided
reply_to_email	Reply-to email address if provided
subject	Email subject line
note	Internal note if provided
patient_name	Patient name if provided
patient_dob	Patient date of birth if provided
record_status	Status: "activated", "archived", or "revoked"
email_status	Delivery status: "queued", "inprogress", "success", or "failure"
secure_link	The secure URL to view the document
expiry	When the secure link expires (ISO 8601)
sent_at	When the email was sent (ISO 8601)
last_viewed_at	When the link was last viewed, or null
is_test	Whether this was sent using test credentials
error_details	Error information if email_status is "failure"

Emails (Secure Links)

Send Secure Link

Get Email