Skip to main content
POST
Preview Blast Recipients

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100

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

data
CohortPatient · object[]
required
total
integer
required