Skip to main content
Mark a specific output (letter) as acknowledged/completed. This sets the output’s read status so it no longer appears in the unread feed.
All endpoints require authentication. For credentials and access, contact the medWrite team.

​
Request

PATCH {{baseUrl}}/api/v1/third-parites/letters/{Output ID}/acknowledge/

​
Headers

HeaderTypeRequiredDescription
Bearer TokenstringYesAuthentication token. Contact medWrite team.
API KeystringYesService API key. Contact medWrite team.

​
Path parameters

ParameterTypeRequiredDescription
Output IDstringYesThe unique identifier of the output.

​
Response

Status: 200 OK 
{
  "data": {
    "id": "...",
    "ehr_read": true,
    "ehr_read_date": "2025-01-15T14:30:00.000000",
    "...": "..."
  },
  "message": "letter acknowledged successfully",
  "status": "success"
}
If the letter was already acknowledged, the response returns "message": "letter already acknowledged" with the existing read date.

​
Error responses

StatusCondition
400Missing Output ID
401Invalid or missing authentication
404Letter not found

​
Next steps

Get Approved Outputs

Retrieve approved letters (FHIR Bundle).

Get PDF Document

Download PDF for an output and bundle.