Skip to main content
View as Markdown

Email Template Entity - Messaging

Email Template Entity​

Every email template has this structure:

FieldTypeDescription
idstringAuto-generated unique identifier (read-only)
partnerIdintegerPartner ID extracted from KS (read-only)
appGuidstringApp Registry GUID this template belongs to
namestringTemplate display name
descriptionstringTemplate description
subjectstringEmail subject line (supports token references)
bodystringEmail HTML body (supports token references)
msgParamsMapobjectToken definitions — maps token names to their types
toAttributePathstringToken expression that resolves to the recipient email (e.g., {recipient.email})
fromstringSender email address
fromNamestringSender display name (supports token references)
ccstringCC email address
bccstringBCC email address
unsubscribeGroupsstring[]Unsubscribe group IDs for CAN-SPAM compliance
statusstringenabled, disabled, or deleted
templateTypestringAlways "email"
adminTagsstringComma-separated tags for filtering
customHeadersobjectCustom email headers (key-value pairs)
numberOfTokenUsedintegerNumber of tokens in the template (read-only)
versionintegerAuto-incrementing version number (read-only)
emailProviderIdstringAssigned email provider (read-only)
createdAtstringISO 8601 timestamp, e.g. "2026-04-09T04:56:27.940Z" (read-only)
updatedAtstringISO 8601 timestamp, e.g. "2026-04-09T04:56:27.940Z" (read-only)