latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

appointments5

appointmentTypes5

assistantActions5

assistantInstances8

assistantTransferRules1

auth5

availabilities4

billingCharges4

billingCopays6

Broadcast Templates6

broadcastEvents4

broadcastFlows9

campaigns4

chatActivities4

chatActivitiesReasons5

chatAudits5

checklists7

checklistTemplates8

customWebStyles5

engagementEvents2

engagements8

engagementSettings5

estimates5

facilities5

fileUploads5

groups5

insurancePayors7

insurances5

knowledgeBaseQuestionAnswers5

lumabotFlows12

lumabotFlowTemplates5

messages4

messageTemplatePartials5

offers5

outboundReferrals5

patientCreditCards5

patientFormPdfFilledDocuments5

patientFormPdfTemplates5

patientForms4

patientFormTemplates6

patientMessageTemplates5

patients6

providers5

providerSchedulingGroups5

queueManagerInstances1

recalls5

referrals6

reminders5

reports5

schedulers1

settings3

specialties14

squigglies1

systemAudits1

users5

waitlists5

Broadcast Templates

Get broadcast template

Retrieves a specific broadcast template by ID

get/broadcastTemplates/{broadcastTemplateId}

Response

Successful operation

_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.

status'draft' | 'complete'

Lifecycle marker for the multi-step builder flow. draft is a work-in-progress; complete (or unset, for pre-feature rows) is consumable by the SFTP filename-driven flow. Defaults to complete on programmatic creates.

titlestring

Title of the broadcast template (optional while status: draft)

messagestring

Legacy single-message body (used by the legacy Broadcast flow). For the broadcast-redesign (BroadcastFlow), use the messages array.

patientMessageTemplatestring

Template for patient-specific messages

campaignstring

Associated campaign identifier

mappingobject

FileMapping reference for the broadcast

secureChatboolean

Legacy template-level secure chat flag (used by the legacy Broadcast flow). For the new flow, secureChat is per-message under messages[].secureChat.

shouldUseUploadedContactsboolean

Legacy boolean (used by the legacy Broadcast flow). For the new flow, use configuration.contactPreference (enum).

shouldUsePrimaryContactOnlyboolean

Legacy boolean (used by the legacy Broadcast flow). For the new flow, use configuration.contactPreference: primary-contact-only.

sendAtstring date-time

Legacy scheduled send time (used by the legacy Broadcast flow). For the new flow, use configuration.scheduledAt.

allowedSquiggliesstring[]

List of allowed template variables resolvable for this template's mapping.

fileUploadstring

Luma's internal ID of an object.