latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

broadcastFlows

Get broadcast flow by ID

get/broadcastFlows/{broadcastFlowId}

Path parameters

broadcastFlowIdstring required

ID of the broadcast flow to retrieve

Query parameters

_populatestring

Response properties which will be replaced by the referenced objects, separated by commas.

_selectstring

Response properties that should be returned, separated by commas.

Response

The broadcast flow was retrieved successfully

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

titlestring
type'scheduled' | 'uploaded' | 'sftp'
parentBroadcastFlowstring

Luma's internal ID of an object.

campaignstring

Luma's internal ID of an object.

broadcastTemplatestring

Luma's internal ID of an object.

patientMessageTemplatestring

Luma's internal ID of an object.

messagestring
sendAtstring date-time
sentAtstring date-time
processingStatus'pre-processing' | 'processing-upload' | 'rows-processed' | 'sending-messages' | 'success' | 'failure'
uploadstring

Luma's internal ID of an object.

fileUploadstring

Luma's internal ID of an object.

mappingstring

Luma's internal ID of an object.

rowCountinteger