Education Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Education Cloud
Release Notes
Education Cloud Data Model Overview
Education Cloud Standard Objects
Education Cloud Fields on Standard Objects
Education Cloud Associated Objects
Education Cloud Standard Value Set Names and Standard Picklist Fields
Education Cloud Tooling API Objects
Education Cloud Business APIs
Fundraising
Fundraising Standard Objects
Fundraising Fields on Other Objects
ContactPointAddress
ContactProfile
ListEmail
Fundraising Business APIs
Fundraising Invocable Actions
Fundraising Metadata API Types
Fundraising Tooling API Objects
PDF

ListEmail

Represents a list email sent from Salesforce, or sent from Account Engagement and synced to Salesforce. When the list email is sent, the recipients are generated by combining recipients in the ListEmailIndividualRecipients and ListEmailRecipientSource objects. Duplicate and other invalid recipients are removed. The result is the recipients are sent any given list email. ListEmail has a one-to-many relationship with ListEmailRecipientSource and ListEmailIndividualRecipient objects. This object is available in API version 61.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

This object is available to Marketing Cloud users with the FundraisingAccess permission set on Marketing Cloud Growth Edition campaigns.

Fields

Field Details
CampaignId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the related campaign.
This field is a relationship field.
Relationship Name
Campaign
Relationship Type
Lookup
Refers To
Campaign
FromAddress
Type
textarea
Properties
Create, Filter, Update
Description
Read-only except when the list email is in a draft state. Validated against user’s addresses.
FromName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Read-only except when the list email is in a draft state. Validated against user’s addresses. This field is null for emails sent from Account Engagement.
HasAttachment
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Read-only. Defaulted on create and update. Indicates if the list email has an attachment (true) or not (false). This field is null for emails sent from Account Engagement.
The default value is false.
HtmlBody
Type
textarea
Properties
Create, Nillable, Update
Description
The body of the list email. This field is null for emails sent from Account Engagement.
List emails can contain up to 32,000 characters for the body. These limits include visible characters and other characters in the email, including markup.
IsOutreachSourceCodeEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether outreach source code can be added to this record (true) or not (false).
The default value is false.
This field is a calculated field.
IsTracked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates if email tracking was on when the list email was sent (true) or not (false). This field is blank for emails sent from Account Engagement and synced to Salesforce. This field is null for emails sent from Account Engagement.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Read-only except when the list email is in a draft state.
OutreachSourceCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The outreach source code associated with the gift transaction.
This field is a relationship field.
Relationship Name
OutreachSourceCode
Relationship Type
Lookup
Refers To
OutreachSourceCode
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of this object.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ScheduledDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Read-only. If null and Status is set to Scheduled, then defaults to created time.
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Read-only except when the list email is in a draft state.
Changing the status to Scheduled causes the list email to be sent.
Valid values are:
  • Cancelled
  • Draft
  • LimitError
  • Running
  • Scheduled
  • Sent
Subject
Type
textarea
Properties
Create, Filter, Nillable, Update
Description
Read-only except when the list email is in a draft state. This field is null for emails sent from Account Engagement.
List emails can contain up to 3,000 characters for the subject. These limits include visible characters and other characters in the email, including markup.
TextBody
Type
textarea
Properties
Create, Nillable, Update
Description
Read-only except when the list email is in a draft state. This field is null for emails sent from Account Engagement.
TotalSent
Type
int
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Read-only. The total number of list emails sent, including bounced, opted-out, and invalid To: addresses.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ListEmailChangeEvent
Change events are available for the object.
ListEmailFeed
Feed tracking is available for the object.
ListEmailHistory
History is available for tracked fields of the object.
ListEmailOwnerSharingRule
Sharing rules are available for the object.
ListEmailShare
Sharing is available for the object.