LifeSciEmailTemplate

Represents a collection of pre-designed and approved email templates that end users send to healthcare professionals (HCPs). These templates help users create and send consistent, professional emails quickly and efficiently. This object is available in API version 65.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AttachmentObjectType

  • Type: multipicklist
  • Properties: Create, Filter, Nillable, Update
  • Description: Specifies the parent objects associated with the record. To configure this field, add the Account picklist value.

    A sales representative selects which object-level attachments, such as Account, are available for the email template. The values configured for this field enable additional attachments from the selected objects to be included when sending the email.

BccEmailIdList

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A list of email addresses to include in the BCC list on emails sent from this template.

CanAttachiCalendarFile

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether an iCalendar (.ics) file is generated and attached to the email.
  • Default value: false

CanSendPresentationLinks

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether sales representatives can share presentations as unique links in email content.
  • Default value: false

CommunicationSubscriptionId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A reference to the communication subscription associated with the email template.

    This field is a relationship field.

  • Relationship Name: CommunicationSubscription
  • Refers To: CommSubscription

Description

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A brief description of the purpose or content of the email template.

EffectiveEndDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date when the email template is no longer available for use by sales representatives.

EffectiveStartDate

  • Type: date
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Required. The date when the email template becomes available for use by sales representatives.

EmailInvitationActionType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Defines the type of action for which the template is used when sending invitations.
  • Possible values:
    • Cancel
    • Create
    • Update

EmailInvitationContextType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the context in which the email template can be used, such as for provider visits.
  • Possible values:
    • ProviderVisit

HasSendConsentAcknowledgement

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: When selected, allows the template to be used for sending customizable emails based on captured consent. Used for custom reporting.
  • Default value: false

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the email template is active or inactive.
  • Default value: false

IsDefaultAutoEmailTemplate

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Identifies whether this template is the default for sending invitations automatically.
  • Default value: false

IsSubjectLineEditable

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Allows the sender to modify the email subject before sending.
  • Default value: false

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view.

    If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. The title or name of the email template.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the owner or creator of this object.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Refers To: Group, User

ProductId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A reference to the product related to the email template.

    This field is a polymorphic relationship field.

  • Relationship Name: Product
  • Refers To: LifeSciMarketableProduct, Product2

ReplyToEmailAddress

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The email address where recipients can send replies.

ReplyToType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the type of email address used for replies. Create these picklist values:
    • Sales Rep Email Address: Uses the sales representative's email address as the Reply to email in the delivered message.
    • Reply To Email Address: Uses the email address specified in the Reply To Email Address field instead of the sales representative's email.

SenderEmailFieldApiName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Stores the API name of custom fields that customers create to store the sender’s email address. Enables customers to use a predefined sender email for specific email templates, rather than using the sales representative's email.

SenderType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Defines the type of sender for the email. Create these picklist values:
    • Sales Rep Email Address: Uses the sales representative's email address as the sender.
    • Sender Email Field API Name: Uses the email address specified in the Sender Email Field API Name field instead of the sales representative's email.

    To configure this field, add picklist values to control the sender information used for email transactions created with this template. By default, the picklist includes "Sales Rep," but you can customize it by adding field API names that contain different sender email addresses.

ShouldIgnoreEmailConsent

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Ignores email consent preferences for this template and sends the email regardless of the recipient's opt-in status.
  • Default value: false

SourceSystemIdentifier

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: An external ID from the source system for data integrations.

SourceSystemName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the source system for data integrations.

SurveyId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A lookup field that links a survey to the email template. To add the survey invitation link to the email, populate the Account field in the Survey Invitation record.

    This field is a relationship field.

  • Relationship Name: Survey
  • Refers To: Survey

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

LifeSciEmailTemplateChangeEvent
Change events are available for the object.
LifeSciEmailTemplateFeed
Feed tracking is available for the object.
LifeSciEmailTemplateHistory
History is available for tracked fields of the object.