Email

Marketing Cloud Engagement has a new model for storing, finding, managing, creating, sharing, and distributing all content-related objects. Access the objects created with the new Content Builder tools using the REST API. Your existing SOAP API integrations only function with the Classic tools.

The Email object represents an email.

  • To create or update an Email with PreHeader populated, you need the Email | Content | Email | PreHeaderAccess permission.
  • To create or update an Email with ClonedFromID populated, you need the Email | Content | Simple Automated Email | Create From Existing Email permission.
NameData TypeDescription
CategoryIDxsd:intSpecifies the identifier of the folder containing the email.
CharacterSetxsd:stringIndicates encoding used in an email message. Valid values include:
  • us-ascii (United States)
  • shift-jis (Japanese)
  • EUC-KR (Korean)
  • iso-8859-1 (Western European)
  • big5 (Chinese)
  • koi8-r (Russian)
  • utf-8 (Unicode)
  • iso-2022-JP (Japanese)
  • iso-8859-2 (Central European)
  • ISO-8859-11 (Thai)
  • GB2312 (Simplified Chinese)
  • iso-8859-6 (Arabic)
ClientClientIDSpecifies the account ownership and context of an object.
ClonedFromIDxsd:intID of email message from which the specified email message was created.
ContentAreasContentArea[]Contains information on content areas included in an email message.
ContentCheckStatusxsd:stringIndicates whether content validation has completed for this email message.
CorrelationIDxsd:stringIdentifies correlation of objects across several requests.
CreatedDatexsd:dateTimeRead-only date and time of the object's creation.
CustomerKeyxsd:stringUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
EmailTypexsd:stringDefines preferred email type.
Folderxsd:stringSpecifies folder information (Retrieve only) - Deprecated.
HasDynamicSubjectLinexsd:booleanIndicates whether email message contains a dynamic subject line.
HTMLBodyxsd:stringContains HTML body of an email message.
IDxsd:intRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
IsActivexsd:booleanSpecifies whether the object is active.
IsHTMLPastexsd:booleanIndicates whether email message was created via pasted HTML.
ModifiedDateNullable`1Indicates the last time object information was modified.
Namexsd:stringName of the object or property.
ObjectIDxsd:stringSystem-controlled, read-only text string identifier for object.
ObjectStatexsd:stringReserved for future use.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyxsd:stringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesAPIProperty[]A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.Pre
PreHeaderxsd:stringContains text used in preheader of email message on mobile devices.
Statusxsd:stringDefines status of object. Status of an address.
Subjectxsd:stringContains subject area information for a message.
SyncTextWithHTMLxsd:booleanMakes the text version of an email contain the same content as the HTML version.
TextBodyxsd:stringContains raw text body of a message.
__AdditionalEmailAttribute1xsd:stringOptional field that lets you specify up to five email attributes on CREATE or RETRIEVE calls. Used to capture analytics or other metadata. Additional attributes are **AdditionalEmailAttribute 2, **AdditionalEmailAttribute3, and so on.