Skip to content
API Docs/
/Batch messages

Create a Batch Message

Request

Create a Batch Message

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
namestringrequired
channelstringrequired
Enum:"SMS""EMAIL""NHS_APP"
subjectstring

The subject is required when channel = EMAIL

contentstringrequired
recipientsArray of anyrequired
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/batch_message \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "channel": "SMS",
    "subject": "string",
    "content": "string",
    "recipients": [
      {
        "nhs_number": "string",
        "dob": "2019-08-24T14:15:22Z"
      }
    ]
  }'

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"
}