Skip to main content

Object Definition Template

Object definition template​

PropertyTypeDescription
IDGuidThe ID of the template
AccountIDGuidThe accountID of the template
NameStringThe name of the template
DescriptionStringThe description of the template
HtmlBodyStringThe html body of the template. This is the body that recipients with a normal e-mail client will get
TextBodyStringThe text body of the template. This is the body that recipients will get when their e-mail client doesn't support HTML
JsonStringThe json of the template. This field is only used when you use our editor. You can leave this blank.
MergeFieldsObjectSee mergefields object definition
TemplateEditorTypeInt (Enum)

The editor type of the template
1 = Drag&DropEditor, template is saved through the Drag&Drop editor and includes valid json to be read by the Drag&Drop editor.
2 = HtmlEditor, template is made up of custom html and not supported by the Drag&Drop editor.

CreatedOnDateTimeWhen the template was created in CET
CreatedOnUtcDateTimeWhen the template was created in UTC
ModifiedOnDateTimeWhen the template was last modified in CET
ModifiedOnUtcDateTimeWhen the template was last modified in UTC
DeletedOnDateTimeWhen the template was deleted in CET
DeletedOnUtcDateTimeWhen the template was deleted in UTC

Object definition merge fields​

PropertyTypeDescription
MergeTagsArray of objectsThe mergetags available. See merge tag object definition
SpecialLinksArray of objectsThe special links available. See special link object definition

Object definition merge tag​

PropertyTypeDescription
NameStringThe name of the merge tag
ValueStringThe value of the merge tag. This is the placeholder that will be replaced in the body of the mail, for example: {{ Recipient.Url }}
MappingStringThe field in the address object it should be replaced with, for example: Recipient.MergeFieldValue1.
PropertyTypeDescription
TypeStringThe of the link, this should be either system or link
LabelStringThe label of the link. This is just for recognizing the link, it won't replace the label in the body.
LinkStringThis is the placeholder in the body that will be replaced, for example [[ SpecialLink.link2 ]]
MappingStringThe url this link should map to, for example: https://www.cm.com. This can also be a merge field, for example: {{ Recipient.Url }}
TagStringThe tag of the link. This will show up in your Data account when the link is clicked.