List Email Object

A list email is a single email sent to a recipient list.

Learn more about list emails in Salesforce Help.

The API to access the List Email object follows the conventions described in Version 5 Overview.

Supported Operations

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/list-emails/<id>?<params>Emails > Emails > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/list-emails?<params>Emails > Emails > View ability

Fields

Read-Only Fields

FieldTypeDescription
idIntID of the list email.
nameStringName of the object for identification in Pardot.
subjectStringThe list email subject.
textMessageStringThe text content of the email's message. This field isn’t queryable.
htmlMessageStringThe HTML content of the email's message. This field isn’t queryable.
campaignIdIntPardot Campaign related to this list email.
isPausedBooleanTrue if the email send is paused.
isSentBooleanTrue if the email has been sent.
isDeletedBooleanTrue if the object is in the recycle bin in Pardot.
replyToOptionsReply To Options[]An array of the reply to address options.
senderOptionsSender Options[]An array of the sender options.
clientTypeStringValue is "Builder" if the email was sent via the Lightning Email Builder. Value is "Web" if it was sent via the legacy Pardot email builder.
createdByIdIntID of the user who created this object.
updatedByIdIntID of the user who last updated this object.
createdAtDateTimeCreation time of the list email.
updatedAtDateTimeLast update time of the list email.
sentAtDateTimeTime the list email was sent.
operationalEmailBooleanTrue if the email is operational.
emailTemplateIdIntID of the email template used for the list email.
trackerDomainIdIntID of the tracker domain used for the list email.
recipientListsRecipient Lists[]An array of the lists used for this list email.
suppressionListsSuppression Lists[]An array of the lists used as suppression lists for the list email.
createdByUserUser object representing the user who created this object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated this object. See documentation for User for fields.
campaignCampaignCampaign object representing the campaign that was set on Create. See documentation for Campaign for fields.

senderOptions Fields

Field NameData TypeDescription
senderOptions.typeEnumThe sending user type. Can be "general user", "specific user", "assigned_user", "account_owner", account_custom_field, or prospect_custom_field.
senderOptions.addressStringThe sending email address.
senderOptions.nameStringThe name of the sender.
senderOptions.userIdIntThe user ID of the sender.
senderOptions.prospectCustomFieldIdIntThe ID of the prospect custom field that contains the sender value.
senderOptions.accountCustomFieldIdIntThe ID of the account custom field that contains the sender value.

replyToOptions Fields

Field NameData TypeDescription
replyToOptions.typeEnumThe reply to user type. Can be "general user", "specific user", "assigned_user", "account_owner", account_custom_field, or prospect_custom_field.
replyToOptions.addressStringThe sending email address.
replyToOptions.nameStringThe name of the sender.
replyToOptions.userIdIntThe user ID of the sender.
replyToOptions.prospectCustomFieldIdIntThe ID of the prospect custom field that contains the sender value.
replyToOptions.accountCustomFieldIdIntThe ID of the account custom field that contains the sender value.

List Email Read

Retrieve a single list email following the conventions described in the Version 5 Overview.

Example request:

Example response:

List Email Query

Retrieving a collection of list emails follows the conventions described in Version 5 Overview.

Example request:

Example response:

Sortable Fields

When executing a query, the following fields can be specified. See the conventions for query described in the Version 5 Overview.

  • id
  • createdAt
  • updatedAt
  • sentAt

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

ParameterDescription
idReturns any list emails where ID is equal to the given integer value.
idGreaterThanReturns any list emails where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any list emails where ID is greater than or equal to the specified value.
idLessThanReturns any list emails where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any list emails where ID is less than or equal to the specified value.
createdAtReturns any list emails where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any list emails where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any list emails where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any list emails where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any list emails where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any list emails where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any list emails where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any list emails where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any list emails where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any list emails where UpdatedAt is before or equal to the given datetime value.
sentAtReturns any list emails where SentAt is equal to the given datetime value.
sentAtAfterReturns any list emails where SentAt is after the given datetime value, non-inclusive.
sentAtAfterOrEqualToReturns any list emails where SentAt is after or equal to the given datetime value.
sentAtBeforeReturns any list emails where SentAt is before the given datetime value, non-inclusive.
sentAtBeforeOrEqualToReturns any list emails where SentAt is before or equal to the given datetime value.