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

");else if(O._boomrl=function(){t()},O.addEventListener)O.addEventListener("load",O._boomrl,!1);else if(O.attachEvent)O.attachEvent("onload",O._boomrl);d.close()}function a(e){window.BOOMR_onload=e&&e.timeStamp||(new Date).getTime()}if(!window.BOOMR||!window.BOOMR.version&&!window.BOOMR.snippetExecuted){window.BOOMR=window.BOOMR||{},window.BOOMR.snippetStart=(new Date).getTime(),window.BOOMR.snippetExecuted=!0,window.BOOMR.snippetVersion=12,window.BOOMR.url=n+"96ZND-LJLSH-JXHC9-F8GQP-6WCGS";var o=document.currentScript||document.getElementsByTagName("script")[0],i=!1,r=document.createElement("link");if(r.relList&&"function"==typeof r.relList.supports&&r.relList.supports("preload")&&"as"in r)window.BOOMR.snippetMethod="p",r.href=window.BOOMR.url,r.rel="preload",r.as="script",r.addEventListener("load",e),r.addEventListener("error",function(){t(!0)}),setTimeout(function(){if(!i)t(!0)},3e3),BOOMR_lstart=(new Date).getTime(),o.parentNode.appendChild(r);else t(!1);if(window.addEventListener)window.addEventListener("load",a,!1);else if(window.attachEvent)window.attachEvent("onload",a)}}(),"".length>0)if(e&&"performance"in e&&e.performance&&"function"==typeof e.performance.setResourceTimingBufferSize)e.performance.setResourceTimingBufferSize();!function(){if(BOOMR=e.BOOMR||{},BOOMR.plugins=BOOMR.plugins||{},!BOOMR.plugins.AK){var n=""=="true"?1:0,t="",a="3be5qrliiz4ua2rpplca-f-812893b58-clientnsv4-s.akamaihd.net",o="false"=="true"?2:1,i={"ak.v":"41","ak.cp":"1836958","ak.ai":parseInt("1224868",10),"ak.ol":"0","ak.cr":28,"ak.ipv":4,"ak.proto":"h2","ak.rid":"1ead0f4b","ak.r":34802,"ak.a2":n,"ak.m":"dsca","ak.n":"essl","ak.cport":19590,"ak.gh":"104.70.121.46","ak.quicv":"","ak.tlsv":"tls1.3","ak.0rtt":"","ak.0rtt.ed":"","ak.csrc":"-","ak.acc":"","ak.t":"1781496516","ak.ak":"hOBiQwZUYzCg5VSAfCLimQ==jepHMpMZk9hRj3ie1aF5aajP/qBbpcOPNA2XhokqOzzIqoWGQXuOYDlWznhCN6SnpvSuW4AQMktH67FCnLoh90e6V6lI8SKdkDnxrEVcaDDbajAZIwdYAtDA4ZtkQcC0qJ2R4q8Tv+eSJVlr7l2Ohl970VS+pRBPjtx7OABH5oknhrE9z+3Zw1+U9KvvFFiEYgeXSqhtXFKBqBScUbAp7IhTxheX55igg28rd+3BTGDpZzOoJ8tqlk3Pf4JQLXAqjplN14SKSvfhpxdxxfGR3Q3FZbp5UE3zzma26qFgjotzFCzoyyNYGBgFgDzY7/EcD0V/jmCsLE8oJW6Ol4u56WBUsfBWH4tv2/B5XzUeoOMoNvUtCA3zRnvqZIzEB9gyKW5llrzidUaMXJui847qpOWNH3viupyal0mjWWGTpzM=","ak.pv":"87","ak.dpoabenc":"","ak.tf":o};if(""!==t)i["ak.ruds"]=t;var r={i:!1,av:function(n){var t="http.initiator";if(n&&(!n[t]||"spa_hard"===n[t]))i["ak.feo"]=void 0!==e.aFeoApplied?1:0,BOOMR.addVar(i)},rv:function(){var e=["ak.cport","ak.cr","ak.csrc","ak.gh","ak.ipv","ak.m","ak.n","ak.ol","ak.proto","ak.quicv","ak.tlsv","ak.0rtt","ak.0rtt.ed","ak.r","ak.acc","ak.t","ak.tf"];BOOMR.removeVar(e)}};BOOMR.plugins.AK={akVars:i,akDNSPreFetchDomain:a,init:function(){if(!r.i){var e=BOOMR.subscribe;e("before_beacon",r.av,null,null),e("onbeacon",r.rv,null,null),r.i=!0}return this},is_complete:function(){return!0}}}}()}(window);hello, goodbye. %%unsubscribe%%", "textMessage": "hello, %%unsubscribe%%", "campaignId" : 1001, "prospectId": 5, "folderId" : 500, "trackerDomainId": 5, "scheduledTime" : "2034-07-25T14:01:17-04:00", "isOperational": false, "emailTemplateId": 22, "senderOptions" : [ { "type" : "account_owner" }, { "type" : "general_user", "name" : "Marketing Team", "address" : "test@example.com" }, { "type" : "specific_user", "userId" : 10000 } ], "replyToOptions" : [ { "type" : "general_address", "address" : "test@test.com" } ] }">

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.

id
sentAt
prospectId

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