Email Template Object
Use an email template to design a reusable email layout for your engagement programs, autoresponders, one-to-one emails, and list emails. Learn about email templates in Salesforce Help.
The API to access the email template 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/email-templates?<params> | Marketing > Emails > Email Templates > Create ability |
| Read | GET | https://pi.pardot.com/api/v5/objects/email-templates/<id>?<params> | Marketing > Emails > Email Templates > View ability |
| Update | PATCH | https://pi.pardot.com/api/v5/objects/email-templates/<id>?<params> | Marketing > Emails > Email Templates > Create ability |
| Delete | DELETE | https://pi.pardot.com/api/v5/objects/email-templates/<id> | Marketing > Emails > Email Templates > Delete ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/email-templates?<params> | Marketing > Emails > Email Templates > View ability |
| Add Tag | POST | https://pi.pardot.com/api/v5/objects/email-templates/<id>/do/addTag | Marketing > Emails > Email Templates > Create AND Marketing > Segmentation > Tags > Create ability |
| Remove Tag | POST | https://pi.pardot.com/api/v5/objects/email-templates/<id>/do/removeTag | Marketing > Emails > Email Templates > Create AND Marketing > Segmentation > Tags > Create ability |
| Field | Type | Description |
|---|
name | String | Name of the email template. |
subject | String | Subject line for the email template. |
isOneToOneEmail | Boolean | If True, the template is available for one-to-one emails. |
isAutoResponderEmail | Boolean | If True, the template is available for autoresponder emails. |
isDripEmail | Boolean | If True, the template is available for Engagement Programs. |
isListEmail | Boolean | If True, the template is available for list emails. |
textMessage | String | The text content of the template’s message. This field isn’t queryable. |
htmlMessage | String | The HTML content of the template’s message. This field isn’t queryable. |
senderOptions | Sender Options[] | An array of sender options. Values are general_user, specific_user, account_owner, prospect_custom_field (Read and Query only), account_custom_field (Read and Query only) |
trackerDomainId | Integer | The ID of the tracker domain associated with this object. |
folderId | Integer | ID of the folder containing this object. |
type | Enum | The content type of the email. Possible values are html (Read and Query only), text, and htmlAndText. |
campaignId | Integer | The ID of the campaign associated with this object. |
| Field | Type | Description |
|---|
replyToOptions | Reply To Options[] | An array of reply to address options. Values are general_address, specific_user, account_owner, prospect_custom_field (Read and Query only), account_custom_field (Read and Query only) |
| Field | Type | Description |
|---|
id | Integer | ID of the email template. |
isDeleted | Boolean | True if the object is in the recycle bin in Account Engagement. |
createdAt | Datetime | Time the email template was created; reported in API user’s timezone. |
updatedAt | Datetime | Time the email template last updated; reported in API user’s timezone. |
createdById | Integer | ID of the user who created this object. |
updatedById | Integer | ID of the user who last updated this object. |
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 the email template. See documentation for Tracker Domain for fields. |
tagReplacementLanguage | Enum | Merge language of the email template. Can be "pml", "hml", or "undetermined". |
| Field Name | Data Type | Description |
|---|
senderOptions.type | Enum | 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. Only available on read and query. |
senderOptions.accountCustomFieldId | Integer | The ID of the account custom field that contains the sender value. Only available on read and query. |
| Field Name | Data Type | Description |
|---|
replyToOptions.type | Enum | 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. |
replyToOptions.accountCustomFieldId | Integer | The ID of the account custom field that contains the reply to value. |
Create a single email template following the conventions described in the Version 5 Overview.
When the Create request succeeds, the email template is considered Published and skips the Draft state.
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="3be5ruaxzcoew2rk52ia-f-f2c906be2-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":9,"ak.ipv":4,"ak.proto":"h2","ak.rid":"9c702a73","ak.r":44386,"ak.a2":n,"ak.m":"dsca","ak.n":"essl","ak.cport":23551,"ak.gh":"23.192.164.80","ak.quicv":"","ak.tlsv":"tls1.3","ak.0rtt":"","ak.0rtt.ed":"","ak.csrc":"-","ak.acc":"","ak.t":"1781198480","ak.ak":"hOBiQwZUYzCg5VSAfCLimQ==8taazw9SBqvwelQtKB5ukduj/2q+lFu7dJyZj7MhgmM/OGZjZW4HQSV1MU9evVtI3RfPu3JJFCwn0nqM1Kx04QMCmX3tTj1WB763lKoADQykpOKQ3lzVrTfdV5iEXo2UPFllB3cM5nh3Dh/aRPJV8Y/+A1UMuveMub7rlHfQetkgq3nGABR/UZzXBcJl9uZIwzL7bNKwbSAbgiIvOm2yNY3rq9ghdFEEXPVTFvLHknn/TUQPF7nEe5zfYnkL+0mN2vQ2fcBJg5tOp782P/of14cQMErx0h9bgKqge/gT0leD9pcqTAQmu+Gtdfe/9k4oby62i4TrHzRzcBQcnxSWPtKWoR0CMbg+VVvDi0Mr32L/CwvL35OBavvDwlEaCbVek2+zWkfkZVJ5eJNyUzCXcTgblIU85v/JR3BWEPMBfzo=","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%%