Sign in
Broadcast Templates

Update broadcast template

Updates an existing broadcast template

put/broadcastTemplates/{broadcastTemplateId}

Request body

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

Response

Broadcast template updated 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.

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.