Skip to main content
POST
/
comms
/
chat
/
send-bulk
Send Bulk Messages
curl --request POST \
  --url https://api.decodahealth.com/comms/chat/send-bulk \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "patientIds": [
    "<string>"
  ],
  "message": "<string>",
  "senderId": "<string>",
  "oneMessagePerNumber": true
}
'
{
  "queuedMessageCount": 123
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Body

application/json

Request model for sending bulk text messages.

​
patientIds
string[]
required
​
message
string
required
​
senderId
string
required
​
oneMessagePerNumber
boolean
default:true

Response

Successful Response

Response model for bulk text messages.

​
queuedMessageCount
integer
required