Email Object
Use email resources to send emails to prospects, and to learn how prospects responded to the emails. Learn more about email in Salesforce Help.
The API to access the 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/emails?<params> | Marketing > Emails > Emails > Send One-to-one ability |
| Read | GET | https://pi.pardot.com/api/v5/objects/emails/<id>?<params> | Marketing > Emails > Emails > View ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/emails?<params> | Marketing > Emails > Emails > View ability |
| Add Tag | POST | https://pi.pardot.com/api/v5/objects/emails/<id>/do/addTag | Marketing > Emails > Emails > Create AND Marketing > Segmentation > Tags > Create ability |
| Remove Tag | POST | https://pi.pardot.com/api/v5/objects/emails/<id>/do/removeTag | Marketing > Emails > Emails > Create AND Marketing > Segmentation > Tags > Create ability |
| Copy to CMS | POST | https://pi.pardot.com/api/v5/objects/emails/<id>/do/copyToCms | Marketing > Emails > Sent > Copy to CMS |
| 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. |
prospectId | Integer | The ID of the prospect you're sending the email to. |
| Field | Type | Description |
|---|---|---|
subject | String | The 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 email. |
trackerDomainId | Integer | The ID of the tracker domain used for the email. |
folderId | Integer | The ID of the folder containing this object. |
| Field | Type | Description |
|---|---|---|
id | Integer | The ID of the email. |
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. |
listId | Integer | This property is deprecated and its value is always null. To view the lists that are associated with an email, retrieve the List Email object for the email. This object contains a reciepientLists property and a suppressionLists property. |
listEmailId | Integer | The ID of the list email associated with this email. |
sentAt | DateTime | The date and time when the email was sent. |
createdBy | User | User object representing the user who created this object. See documentation for User for fields. |
campaign | Campaign | Campaign object representing the campaign associated with this object. See documentation for Campaign for fields. |
list | List | List object representing the list associated with this email. See documentation for List for fields. |
listEmail | List Email | List Email object representing the list email associated with this email. See documentation for List Email for fields. |
salesforceCmsId | String | The ID of the copied email when using copyToCms. If the email isn't successfully copied, the value is null. |
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 | String | The sending user type. Possible values: 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. For Create operations, the only possible value is general_address. |
replyToOptions.address | String | The reply-to email address. |
replyToOptions.userId | Integer | The user ID of the reply to sender. This field isn’t editable. |
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 a single prospect following the conventions described in the Version 5 Overview. You can specify the prospect by Account Engagement ID.
For List Email Send, refer to List Email Create.
Example Request
A successful request returns an HTTP 201 response. The response lists the fields that were specified in the request.
Retrieve a single email following the conventions described in the Version 5 Overview. To understand how data is passed, review Data Types.
Example Request
Example Response
Retrieve a collection of emails by using the conventions described in Version 5 Overview. To understand how data is passed, review Data Types.
idsentAtprospectId
When you execute a query, these 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 you specify more than one parameter, the results only include records that match all of the parameters.
| Parameter | Description |
|---|---|
id | Returns any email where the ID is equal to the given integer value. |
idList | Returns any email where the ID is included in the given list of values. |
idGreaterThan | Returns any email where the ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any email where the ID is greater than or equal to the specified value. |
idLessThan | Returns any email where the ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any email where the ID is less than or equal to the specified value. |
prospectId | Returns any email where the Prospect ID is equal to the given integer value. |
prospectIdGreaterThan | Returns any email where the Prospect ID is greater than the specified value, non-inclusive. |
prospectIdGreaterThanOrEqualTo | Returns any email where the Prospect ID is greater than or equal to the specified value. |
prospectIdLessThan | Returns any email where the Prospect ID is less than the specified value, non-inclusive. |
prospectIdLessThanOrEqualTo | Returns any email where the Prospect ID is less than or equal to the specified value. |
listEmailId | Returns any email where the List Email ID is equal to the given integer value. |
listEmailIdGreaterThan | Returns any email where the List Email ID is greater than the specified value, non-inclusive. |
listEmailIdGreaterThanOrEqualTo | Returns any email where the List Email ID is greater than or equal to the specified value. |
listEmailIdLessThan | Returns any email where the List Email ID is less than the specified value, non-inclusive. |
listEmailIdLessThanOrEqualTo | Returns any email where the List Email ID is less than or equal to the specified value. |
sentAt | Returns any email where SentAt is equal to the given datetime value. |
sentAtAfter | Returns any email where SentAt is after the given datetime value, non-inclusive. |
sentAtAfterOrEqualTo | Returns any email where SentAt is after or equal to the given datetime value. |
sentAtBefore | Returns any email where SentAt is before the given datetime value, non-inclusive. |
sentAtBeforeOrEqualTo | Returns any email where SentAt is before or equal to the given datetime value. |
Example Response
Adds a Tag to the Email object, which creates a TaggedObject.
Example Request
Example Response
Remove a tag from an Email object. When you remove a tag, the associated TaggedObject record is deleted.
Example Request
Example Response
Returns code 204 no content.
Copy a sent email to your Salesforce CMS Marketing workspace.
Example Request
Example Response