Email

An object that represents a classic email in Email Studio.

To manage Content Builder emails, use the Assets endpoints in REST API.

NameData TypeDescription
CategoryIDIntSpecifies the identifier of the folder containing the email.
CharacterSetStringIndicates 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)
ClientClientID objectSpecifies the account ownership and context of an object.
ClonedFromIDIntID of email message from which the specified email message was created.
ContentAreasArray of objectsContains information about content areas included in an email message.
ContentCheckStatusStringIndicates whether content validation has completed for this email message.
CorrelationIDStringIdentifies correlation of objects across several requests.
CreatedDateDateTimeThe date and time when the object was created.
CustomerKeyStringUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
EmailTypeEmailTypeIndicates whether the email contains HTML or plain text.
FolderStringSpecifies folder information (Retrieve only) - Deprecated.
HasDynamicSubjectLineBooleanIndicates whether email message contains a dynamic subject line.
HTMLBodyStringContains HTML body of an email message.
IDIntRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
IsActiveBooleanSpecifies whether the object is active.
IsHTMLPasteBooleanIndicates whether email message was created via pasted HTML.
ModifiedDateDateTimeThe date and time when the object was last modified.
NameStringName of the object or property.
ObjectIDStringSystem-controlled, read-only text string identifier for object.
ObjectStateStringNot used.
OwnerOwner objectDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyStringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. These properties are accessible only by using the API.
PreHeaderStringContains text used in preheader of email message on mobile devices.
StatusStringDefines status of object. Status of an address.
SubjectStringContains subject area information for a message.
SyncTextWithHTMLBooleanMakes the text version of an email contain the same content as the HTML version.
TextBodyStringContains raw text body of a message.
__AdditionalEmailAttribute1StringOptional field that lets you specify up to five email attributes in CREATE or RETRIEVE calls. Used to capture analytics or other metadata. Additional attributes are AdditionalEmailAttribute2, AdditionalEmailAttribute3, and so on.