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.

OperationHTTP VerbURL FormatAbility Requirements
CreatePOSThttps://pi.pardot.com/api/v5/objects/email-templatesEmails > Email Templates > Create ability
ReadGEThttps://pi.pardot.com/api/v5/objects/email-templates/<id>?<params>Emails > Email Templates > View ability
UpdatePATCHhttps://pi.pardot.com/api/v5/objects/email-templates/<id>?<params>Emails > Email Templates > Create ability
DeleteDELETEhttps://pi.pardot.com/api/v5/objects/email-templates/<id>Emails > Email Templates > Delete ability
QueryGEThttps://pi.pardot.com/api/v5/objects/email-templates?<params>Emails > Email Templates > View ability

Required Editable Fields

FieldTypeDescription
nameStringName of the email template.
subjectStringSubject line for the email template.
isOneToOneEmailBooleanIf True, the template is available for one-to-one emails.
isAutoResponderEmailBooleanIf True, the template is available for autoresponder emails.
isDripEmailBooleanIf True, the template is available for Engagement Programs.
isListEmailBooleanIf True, the template is available for list emails.
textMessageStringThe text content of the template's message. This field isn’t queryable.
htmlMessageStringThe HTML content of the template's message. This field isn’t queryable.
senderOptionsSender 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)
trackerDomainIdIntThe ID of the tracker domain associated with this object.
folderIdIntID of the folder containing this object.
typeEnum"html", "text", and "htmlAndText" values.
campaignIdIntThe ID of the campaign associated with this object.

Optional Editable Fields

FieldTypeDescription
replyToOptionsReply 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)

Read-Only Fields

FieldTypeDescription
idIntID of the email template.
isDeletedBooleanTrue if the object is in the recycle bin in Pardot.
createdAtDatetimeTime the email template was created; reported in API user's timezone.
updatedAtDatetimeTime the email template last updated; reported in API user's timezone.
createdByIdIntID of the user who created this object.
updatedByIdIntID of the user who last updated this object.
createdByUserUser object representing the user who created this object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated this object. See documentation for User for fields.
campaignCampaignCampaign object representing the campaign that was set on Create. See documentation for Campaign for fields.
folderFolderJSON object representing the folder for this object. See documentation for Folder for fields.
trackerDomainTracker DomainTracker Domain object representing the tracker domain associated with the email template. See documentation for Tracker Domain for fields.

senderOptions Fields

Field NameData TypeDescription
typeEnumThe 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.
addressStringThe sending email address.
nameStringThe name of the sender.
userIdIntThe user ID of the sender.
prospectCustomFieldIdIntThe ID of the prospect custom field that contains the sender value. Only available on read and query.
accountCustomFieldIdIntThe ID of the account custom field that contains the sender value. Only available on read and query.

replyToOption Fields

Field NameData TypeDescription
typeEnumThe 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.
addressStringThe sending email address.
nameStringThe name of the sender.
userIdIntThe user ID of the sender.
prospectCustomFieldIdIntThe ID of the prospect custom field that contains the sender value. Only available on read and query.
accountCustomFieldIdIntThe ID of the account custom field that contains the sender value. Only available on read and query.

Create a single email template following the conventions described in the Version 5 Overview.

Example Request

Example Response

Responds with code 201 created and returns any fields specified in the request.

Retrieve a single email template following the conventions described in the Version 5 Overview.

Example Request

Example Response

Updates an email template following the conventions described in the Version 5 Overview.

Example Request

Example Response

Responds with 200 OK and returns any fields specified in the request.

Deletes an email template following the conventions described in the Version 5 Overview.

Example Request

Example Response

Returns code 204 no content.

Retrieve a collection of email templates following the conventions described in the Version 5 Overview.

Example Request

Example Response

Sortable Fields

When executing a query, the following fields can be specified in the orderBy parameter. See the conventions for query described in the Version 5 Overview.

ParameterDescription
idID of the email template.
createdAtTime the email template was created; reported in API user's timezone.
updatedAtTime the email template last updated; reported in API user's timezone.

Filtering Results

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.

ParameterDescription
isOneToOneIf True, the template is available for one-to-one emails.
idReturns any email templates where ID is equal to the given integer value.
idGreaterThanReturns any email templates where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any email templates where ID is greater than or equal to the specified value.
idLessThanReturns any email templates where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any email templates where ID is less than or equal to the specified value.
createdAtReturns any email templates where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any email templates where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any email templates where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any email templates where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any email templates where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any email templates where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any email templates where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any email templates where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any email templates where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any email templates where UpdatedAt is before or equal to the given datetime value.
deletedDetermines whether to return deleted records. The value can be false (default), true, or all.