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

Get message

GET /api/v2/messages/:id - Fetch a single message by id.

GET/api/v2/messages/:id

Fetch a single message by id.

Required scope: messages (or *).

Path parameters

NameRequiredDescription
idYesMessage id (numeric id or message_uuid)
 
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/messages/10042"
{
  "success": true,
  "message": {
    "id": 10042,
    "contact_uuid": "c0a80101-0000-4000-8000-000000000001",
    "is_read": false,
    "message_text": "Thanks for calling back"
  }
}

See Errors for the standard error envelope and rate limits.