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.

Include the authentication header with every request. For information on how to authenticate, see Authentication.

Resource NameOperationDescription
Email Template ReadGETRequest information about a single email template.
One-to-One Email TemplatesGETRequest information about the email templates that are used in one-to-one emails.

Request information about a single email template.

Replace <ID> with the Account Engagement ID of the email template.

Use this parameter to specify the email templates to return.

ParameterTypePossible ValuesDescription
archivedbooleantrue, falseIf true, the request returns archived and unarchived templates. If false, only unarchived templates are returned. Default value is false.

Request the email templates that are enabled for one-to-one emails.

Use this parameter to specify which one-to-one email templates to return.

ParameterTypePossible ValuesDescription
archivedbooleantrue, falseIf true, the request returns both archived and unarchived templates. If false, only unarchived templates are returned. Default is false.

Use the XML response for read requests and one-to-one requests to learn more about your email templates.

TagDescription
<emailTemplate>Parent tag. Contains data fields for a single email template.
<error>Flag if an error occurred.
<errorCode>Code for the error which occurred.
<errorMessage>Description of the error.
<sendOptions>The associated send options object, including sender-specific data.
<replyToAddress>The email address in the email's Reply-To header.
<sendFromData>A JSON array representing the sender hierarchy tied to the email template.
<id>The Account Engagement ID of the email template.
<name>The name of the email template.
<htmlMessage>The HTML version of the email template body.
<textMessage>The plain text version of the email template body.
<isDripEmail>Flag if the template is available for use in engagement programs.
<isListEmail>Flag if the template is available for use in list emails.
<subject>The subject of the email message.
TagDescription
<emailTemplates>Parent tag. Contains individual email template records.
<templates>Parent tag for each template.
<id>The Account Engagement ID of the email template.
<name>The name of the email template.
<isOneToOneEmail>Flag if the email template is available for use in one-to-one emails (always true).
<isArchived>Flag if the email template is in the Recycle Bin in Account Engagement.
<isAutoResponderEmail>Flag if the email template is available for use as an auto response from a form submission.
<isDripEmail>Flag if the email template is available for use in engagement programs.
<isListEmail>Flag if the email template is available for use in list emails.
<subject>The subject of the email message.