Skip to content
API Docs/
API Reference
/
/
List Batch Messages

List Batch Messages

Request

List Batch Messages

Security
apiKeyAuth and practiceGroupId
Query
page_sizeinteger
page_indexinteger
statusstring
Enum:"CREATED""ENRICHMENT_ERROR""ENRICHED""INVALID_PAYLOAD""QUEUED"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/batch_message?page_size=0&page_index=0&status=CREATED' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstringrequired
namestringrequired
statusstringrequired
Enum:"CREATED""PENDING""SENDING""COMPLETED"
channelstringrequired
Enum:"SMS""EMAIL""NHS_APP"
subjectstring
contentstringrequired
Response
{
  "id": "string",
  "name": "string",
  "status": "CREATED",
  "channel": "SMS",
  "subject": "string",
  "content": "string"
}