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.
| Operation | HTTP Verb | URL Format | Ability Requirements |
|---|---|---|---|
| Read | GET | https://pi.pardot.com/api/v5/objects/list-emails/<id>?<params> | Emails > Emails > View ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/list-emails?<params> | Emails > Emails > View ability |
| Field | Type | Description |
|---|---|---|
id | Integer | ID of the list email. |
name | String | Name of the object for identification in Account Engagement. |
subject | String | The list email subject. |
textMessage | String | The text content of the email's message. This field isn’t queryable. |
htmlMessage | String | The HTML content of the email's message. This field isn’t queryable. |
campaignId | Integer | Account Engagement Campaign related to this list email. |
isPaused | Boolean | True if the email send is paused. |
isSent | Boolean | True if the email has been sent. |
isDeleted | Boolean | True if the object is in the recycle bin in Account Engagement. |
replyToOptions | Reply To Options[] | An array of the reply to address options. |
senderOptions | Sender Options[] | An array of the sender options. |
clientType | String | Value is "Builder" if the email was sent via the Lightning Email Builder. Value is "Web" if it was sent via the legacy Account Engagement email builder. |
createdById | Integer | ID of the user who created this object. |
updatedById | Integer | ID of the user who last updated this object. |
createdAt | DateTime | Creation time of the list email. |
updatedAt | DateTime | Last update time of the list email. |
sentAt | DateTime | Time the list email was sent. |
operationalEmail | Boolean | True if the email is operational. |
emailTemplateId | Integer | ID of the email template used for the list email. |
trackerDomainId | Integer | ID of the tracker domain used for the list email. |
recipientLists | Recipient Lists[] | An array of the lists used for this list email. |
suppressionLists | Suppression Lists[] | An array of the lists used as suppression lists for the list email. |
createdBy | User | User object representing the user who created this object. See documentation for User for fields. |
updatedBy | User | User object representing the user who last updated this object. See documentation for User for fields. |
campaign | Campaign | Campaign object representing the campaign that was set on Create. See documentation for Campaign for fields. |
| Field Name | Data Type | Description |
|---|---|---|
senderOptions.type | Enum<string> | The sending user type. Can be "general user", "specific user", "assigned_user", "account_owner", account_custom_field, or prospect_custom_field. |
senderOptions.address | String | The sending email address. |
senderOptions.name | String | The name of the sender. |
senderOptions.userId | Integer | The user ID of the sender. |
senderOptions.prospectCustomFieldId | Integer | The ID of the prospect custom field that contains the sender value. |
senderOptions.accountCustomFieldId | Integer | The ID of the account custom field that contains the sender value. |
| Field Name | Data Type | Description |
|---|---|---|
replyToOptions.type | Enum<string> | The reply to user type. Can be "general user", "specific user", "assigned_user", "account_owner", account_custom_field, or prospect_custom_field. |
replyToOptions.address | String | The sending email address. |
replyToOptions.name | String | The name of the sender. |
replyToOptions.userId | Integer | The user ID of the sender. |
replyToOptions.prospectCustomFieldId | Integer | The ID of the prospect custom field that contains the sender value. |
replyToOptions.accountCustomFieldId | Integer | The ID of the account custom field that contains the sender value. |
Retrieve a single list email following the conventions described in the Version 5 Overview.
Example request:
Example response:
Retrieving a collection of list emails follows the conventions described in Version 5 Overview.
Example request:
Example response:
When executing a query, the following fields can be specified. See the conventions for query described in the Version 5 Overview.
idcreatedAtupdatedAtsentAt
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.
| Parameter | Description |
|---|---|
id | Returns any list emails where ID is equal to the given integer value. |
idList | Returns any list emails where ID is included in the given list of values. |
idGreaterThan | Returns any list emails where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any list emails where ID is greater than or equal to the specified value. |
idLessThan | Returns any list emails where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any list emails where ID is less than or equal to the specified value. |
createdAt | Returns any list emails where CreatedAt is equal to the given datetime value. |
createdAtAfter | Returns any list emails where CreatedAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any list emails where CreatedAt is after or equal to the given datetime value. |
createdAtBefore | Returns any list emails where CreatedAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any list emails where CreatedAt is before or equal to the given datetime value. |
updatedAt | Returns any list emails where UpdatedAt is equal to the given datetime value. |
updatedAtAfter | Returns any list emails where UpdatedAt is after the given datetime value, non-inclusive. |
updatedAtAfterOrEqualTo | Returns any list emails where UpdatedAt is after or equal to the given datetime value. |
updatedAtBefore | Returns any list emails where UpdatedAt is before the given datetime value, non-inclusive. |
updatedAtBeforeOrEqualTo | Returns any list emails where UpdatedAt is before or equal to the given datetime value. |
sentAt | Returns any list emails where SentAt is equal to the given datetime value. |
sentAtAfter | Returns any list emails where SentAt is after the given datetime value, non-inclusive. |
sentAtAfterOrEqualTo | Returns any list emails where SentAt is after or equal to the given datetime value. |
sentAtBefore | Returns any list emails where SentAt is before the given datetime value, non-inclusive. |
sentAtBeforeOrEqualTo | Returns any list emails where SentAt is before or equal to the given datetime value. |