Skip to main content
POST
Preview Blast

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
channel
enum<string>
required
Available options:
SMS,
EMAIL
cohortId
string | null
cohortIds
string[] | null
patientIds
string[] | null
isMarketing
boolean
default:false

Response

Successful Response

willSend
integer
default:0
optedOut
integer
default:0
noContactInfo
integer
default:0
suppressed
integer
default:0
unsubscribed
integer
default:0
notOptedIn
integer
default:0
failedValidation
integer
default:0
total
integer
default:0