Skip to content
API reference/
API Reference
/
/
Get Message Status

Get Message Status

Request

Retrieve message write to record and send status

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/messages/{id}/status' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstringrequired
scheduled_send_atstring or null, (date-time)required
write_to_recordbooleanrequired
statusobjectrequired
errorsobjectrequired
Response
{
  "id": "string",
  "scheduled_send_at": "2019-08-24T14:15:22Z",
  "write_to_record": true,
  "status": {
    "write_to_record_at": "2019-08-24T14:15:22Z",
    "sent_at": "2019-08-24T14:15:22Z",
    "response": "delivered",
    "failure_reason": "string"
  },
  "errors": {
    "write_to_record": "string",
    "send": "string"
  }
}