Skip to main content
POST
Mark a memo as read by the authenticated employee. This updates the read status for the memo recipient and tracks when the memo was acknowledged.

​
Authentication

Requires authentication with Bearer token. Available to:
  • Employee
  • Manager
  • HR Manager
  • Super Admin
Only memo recipients can mark the memo as read. The system automatically tracks which employee marked it as read based on the authentication token.

​
Path Parameters

​
string
required
The unique identifier of the memo (UUID format)Example: "550e8400-e29b-41d4-a716-446655440000"

​
Response

​
boolean
Indicates if the request was successful
​
string
Confirmation message

​
Behavior

Key behaviors:
  • Marking a memo as read is idempotent - calling it multiple times has no additional effect
  • The read timestamp is recorded the first time this endpoint is called
  • Read status is tracked per recipient (multiple recipients can have different read states)
  • Only the recipient specified in the memo’s recipient list can mark it as read

​
Use Cases

This endpoint is typically used when:
  • An employee opens and views a memo in their inbox
  • Building read receipt functionality in notification systems
  • Tracking memo acknowledgment for compliance purposes
  • Updating unread badge counts in the UI

​
Memo Read Tracking

The system tracks:
The employee ID is captured from the authentication token
A timestamp is recorded when the endpoint is first called
Admins and memo creators can see what percentage of recipients have read the memo
In your UI, automatically call this endpoint when a user opens a memo detail page to keep read status synchronized.