Skip to main content
POST
Create 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
name
string | null
Maximum string length: 255
cohortId
string | null
cohortIds
string[] | null
patientIds
string[] | null
attachments
string[] | null
smsContent
string | null
emailSubject
string | null
emailBodyHtml
string | null
emailBodyText
string | null
emailPreviewText
string | null
Maximum string length: 255
fromName
string | null
Maximum string length: 255
isMarketing
boolean
default:false
skipNotOptedIn
boolean
default:true

Response

Successful Response

id
string
required
channel
enum<string>
required
Available options:
SMS,
EMAIL
status
enum<string>
required
Available options:
PENDING,
SENDING,
WARMING,
COMPLETED,
PARTIALLY_FAILED,
FAILED,
STOPPED
senderId
string
required
createdDate
string<date-time>
required
name
string | null
cohortId
string | null
cohortName
string | null
cohortIds
string[] | null
cohortNames
string[] | null
totalRecipients
integer
default:0
sentCount
integer
default:0
deliveredCount
integer
default:0
failedCount
integer
default:0
bouncedCount
integer
default:0
optedOutCount
integer
default:0
sentAt
string<date-time> | null
completedAt
string<date-time> | null