Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

Mark message read

POST /api/v2/messages/:id/read - Marks a message read or unread. Defaults to read=true.

POST/api/v2/messages/:id/read

Marks a message read or unread. Defaults to read=true.

Required scope: messages (or *).

Path parameters

NameRequiredDescription
idYesMessage id

JSON body

NameRequiredDescription
readNotrue (default) or false
 
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"
{ "success": true, "updated": true, "is_read": true }

See Errors for the standard error envelope and rate limits.