Update a prepared message

Updated

1 minute(s) read

Post

/preparedmessage/update

Update prepared message.

trackingOverride controls message tracking consent override behavior:
1 = no override; per-contact tracking consent applies.
2 = full override; open and link-click tracking are enforced for all recipients regardless of individual consent.
Any other value is rejected by this API.
On update, omit trackingOverride or send null to preserve the existing stored value; set trackingOverride to 1 explicitly to clear an active override.

Body parameters

Prepared message body.

trackingOverride controls message tracking consent override behavior:
1 = no override; per-contact tracking consent applies.
2 = full override; open and link-click tracking are enforced for all recipients regardless of individual consent.
Any other value is rejected by this API.
On update, omit trackingOverride or send null to preserve the existing stored value; set trackingOverride to 1 explicitly to clear an active override.

Expand All

object

contactId

integer (int64)

messageId

integer (int64)

name

string

groupId

integer (int64)

groupName

string

selectionId

integer (int64)

selectionName

string

channelId

integer (int64)

channelName

string

externalId

string

messageCategoryId

integer (int64)

messageCategoryName

string

message

object (MessageBase)

subject

string

emailBodyText

string

emailBodyHtml

string

smsText

string

faxText

string

emailHeaders

Array of object (Attribute)

object

name

string

value

string

attachments

Array of object (Attachment)

object

name

string

contentType

string

content

string

attachmentReferences

Array of object (AttachmentReference)

object

contentId

string

reference

string

encoding

string

encodingSMS

string

imageHandlingMode

string

trackingOverride

integer (int64)

Responses

204

400

Was this article helpful?

Documentation Index

Update a prepared message