Email

Marketing Cloud 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 in Marketing Cloud.

The Email object represents an email in Marketing Cloud.

  • 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.

Properties

NameData TypeDescription
CategoryIDxsdSpecifies the identifier of the folder containing the email.
CharacterSetxsdIndicates 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.
ClonedFromIDxsdID of email message from which the specified email message was created.
ContentAreasContentArea[]Contains information on content areas included in an email message.
ContentCheckStatusxsdIndicates whether content validation has completed for this email message.
CorrelationIDxsdIdentifies correlation of objects across several requests.
CreatedDatexsdRead-only date and time of the object's creation.
CustomerKeyxsdUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object in Marketing Cloud.
EmailTypexsdDefines preferred email type.
FolderxsdSpecifies folder information (Retrieve only) - Deprecated.
HasDynamicSubjectLinexsdIndicates whether email message contains a dynamic subject line.
HTMLBodyxsdContains HTML body of an email message.
IDxsdRead-only identifier for an object. Some objects use the ObjectID property as the Marketing Cloud unique ID.
IsActivexsdSpecifies whether the object is active.
IsHTMLPastexsdIndicates whether email message was created via pasted HTML.
ModifiedDateNullable`1Indicates the last time object information was modified.
NamexsdName of the object or property.
ObjectIDxsdSystem-controlled, read-only text string identifier for object.
ObjectStatexsdReserved for future use.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyxsdUnique 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
PreHeaderxsdContains text used in preheader of email message on mobile devices.
StatusxsdDefines status of object. Status of an address.
SubjectxsdContains subject area information for a message.
SyncTextWithHTMLxsdMakes the text version of an email contain the same content as the HTML version.
TextBodyxsdContains raw text body of a message.
__AdditionalEmailAttribute1xsdOptional 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.