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 |
|---|---|---|---|
| Create | POST | https://pi.pardot.com/api/v5/objects/list-emails?<params> | Marketing > Emails > Emails > Send To List ability |
| Read | GET | https://pi.pardot.com/api/v5/objects/list-emails/<id>?<params> | Marketing > Emails > Emails > View ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/list-emails?<params> | Marketing > Emails > Emails > View ability |
| Statistics | GET | https://pi.pardot.com/api/v5/objects/list-emails/<id>/stats | Marketing > Emails > Emails > View Report ability |
| Field | Type | Description |
|---|---|---|
name | String | The name of the object for identification in Account Engagement. |
campaignId | Integer | The ID of the campaign related to this object. |
recipientListIds | Array | An array of IDs of the recipient lists. The email is sent to all users on the specified lists. Write-Only field on create operation. |
| Field | Type | Description |
|---|---|---|
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. |
senderOptions | Sender Options[] | An array of the sender options. |
replyToOptions | Reply To Options[] | An array of the reply to address options. |
scheduledTime | DateTime | The ISO 8601 date and time to send the email. Write-Only field on create operation. |
isOperational | Boolean | When true, the email is sent to the prospect regardless of opt-out status. Your account must have Operational Email Sending enabled to use this setting. |
emailTemplateId | Integer | The ID of the email template used for the list email. |
trackerDomainId | Integer | The ID of the tracker domain used for the list email. |
suppressionListIds | Array | An array of IDs of the suppression lists. The email isn’t sent to any user on the suppression lists. Write-Only field on create operation. |
folderId | Integer | The ID of the folder containing this object. |
| Field | Type | Description |
|---|---|---|
id | Integer | The ID of the 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. |
clientType | String | The type of client that was used to send the email. The value is Builder if the email was sent using the Lightning Email Builder, or Web if it was sent using the legacy Pardot email builder. |
createdById | Integer | The ID of the user who created this object. |
updatedById | Integer | The 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 | The date and time when the list email was sent. |
operationalEmail | Boolean | Deprecated. Use isOperational instead. True if the email is operational. |
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. |
folder | Folder | JSON object representing the folder for this object. See documentation for Folder for fields. |
trackerDomain | Tracker Domain | Tracker Domain object representing the tracker domain associated with this object. See documentation for Tracker Domain for fields. |
type | Enum | The content type of the email. Possible values are html (Read and Query only), text, and htmlAndText. |
| Field Name | Data Type | Description |
|---|---|---|
senderOptions.type | Enum<string> | The sending user type. Can be general_user, specific_user, assigned_user or account_owner. When performing read or query, account_custom_field and prospect_custom_field are also available. |
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_address, specific_user, assigned_user or account_owner. When performing read or query, account_custom_field and prospect_custom_field are also available. |
replyToOptions.address | String | The reply-to email address. |
replyToOptions.userId | Integer | The user ID of the reply to sender. |
replyToOptions.prospectCustomFieldId | Integer | The ID of the prospect custom field that contains the reply to value. This field isn’t editable. |
replyToOptions.accountCustomFieldId | Integer | The ID of the account custom field that contains the reply to value. This field isn’t editable. |
Send an email to every prospect on the specified list following the conventions described in the Version 5 Overview.
Example Request
A successful request returns an HTTP 201 response. The response lists the fields that were specified in the request.
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:
Request statistical information for a list email, such as the number of clicks, opens, and opt-outs.
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. |