Mark message read
POST /api/v2/messages/:id/read - Marks a message read or unread. Defaults to read=true.
POST
/api/v2/messages/:id/readMarks a message read or unread. Defaults to read=true.
Required scope: messages (or *).
Path parameters
| Name | Required | Description |
|---|---|---|
id | Yes | Message id |
JSON body
| Name | Required | Description |
|---|---|---|
read | No | true (default) or false |
Example request
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"read": true
}' \
"https://benefitpath.com/api/v2/messages/10042/read"Example response
{ "success": true, "updated": true, "is_read": true }