Get a prepared message

Prev Next
Get
/preparedmessage/get

Returns a prepared message identified by messageId. Omit contactId or leave it empty to get the raw (not personalized) message. When contactId is provided, the message is personalized for that contact, who must be a member of the prepared message's group. If the contact has no email address, email personalization is skipped and the email HTML/text remains raw (not personalized).

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.
3 = anonymized aggregate tracking for recipients whose consent is denied or withdrawn.
Any other value is rejected by this API.

Query parameters
messageId
integer (int64) Required

The prepared message ID

contactId
integer (int64)

Optional contact ID for personalization. Omit or leave empty to get the raw (not personalized) message. When provided, the contact must be a member of the prepared message's group. If the contact has no email address, the email HTML/text remains raw (not personalized).

Responses
200

{
"contactId": 45802709,
"messageId": 7579,
"name": "JohnPreparedWithCustom20220215",
"groupId": 3302,
"groupName": "John20220208",
"selectionId": null,
"selectionName": null,
"channelId": 327699,
"channelName": "DMC Email",
"externalId": null,
"messageCategoryId": null,
"messageCategoryName": null,
"trackingOverride": 2,
"message": {
"subject": "JohnPreparedWithCustom20220215",
"emailBodyText": null,
"emailBodyHtml": "JohnPreparedWithCustom20220215\r\nEmail(standard) tt7177798@gmail.comtt7178198@gmail.com\r\nEmail(Custom) OBFUSCATEDtt71778198@gmail.com</body></html>",
"smsText": null,
"faxText": null,
"emailHeaders": [],
"attachments": [],
"attachmentReferences": null,
"encoding": "ISO-8859-1",
"encodingSMS": "ISO-8859-1",
"imageHandlingMode": "none"
}
}

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)
400

Please enter a valid prepared message ID, Please enter a valid test contact ID to get the personalized HTML, No membership for user '25493969' in group '2186' found.