---
schema_version: "1"
id: 3e0f88144592b98e743e5a6c2760d402ae501f13e5dee2689d0265fef3bac218
title: Email Template (PATCH)
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/life_sciences_dev_guide/connect_resources_bulk_email_template_patch.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_bulk_email_template_patch.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 7bf4ffab26a52afc38b064d1366e41c3017aa456364133249c49951c69039ec4
description: Update an email template.The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see Email Template and Intelligent Content.
---
# Email Template (PATCH)

Update an email template.The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US).

## Resource

/connect/life-sciences/commercial/bulk-email-template

## Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/bulk-email-template

## Available Version

65.0

## HTTP Methods

PATCH

![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png)

#### Note

- File Input Payload Size:
    - Overall API Payload Limit: The total request payload limit across APIs is 2 GB. When attaching single or multiple files as binary inputs using fileId, this 2 GB limit applies to the entire combined request payload.
- Rate Limits:
    - Bulk Presentation (POST and PATCH): The rate limit is 200 API calls per org per hour.

## Request Body for PATCH

{
    "emailSubject": "Welcome",
    "contentDocumentId": "069xx0000004CAeAAM",
    "name": "Welcome Email",
    "activatedDate": "2025-06-03T15:00:00.000Z",
    "senderType": "SYSTEM",
    "senderEmailFieldAPIName": "noreply@company.com",
    "replyToType": "USER",
    "replyToEmailAddress": "support@company.com",
    "id": "email-template-id",
    "deactivatedDate": "2025-01-01T00:00:00.000Z",
    "description": "This is a welcome email template used for onboarding new users.",
    "attachmentObjectTypes": \[
        "PDF",
        "DOCX"
    \],
    "customFields": \[
        {
            "fieldName": "user",
            "fieldValue": "admin"
        },
        {
            "fieldName": "standard",
            "fieldValue": "user"
        }
    \],
    "languages": \[
        "en",
        "es"
    \],
    "isActive": true,
    "surveyId": "sample-survey-id",
    "productId": "sample-product-id",
    "communicationSubscriptionId": "sample-comm-subscription-id",
    "topics": \[
        "Onboarding",
        "User Engagement"
    \],
    "shouldIgnoreEmailConsent": false,
    "isSubjectLineEditable": true,
    "bccEmailIdList": "bcc@example.com",
    "automatedEmailContextType": "ProviderVisit",
    "automatedEmailActionType": "Create",
    "isDefaultAutoEmailTemplate": false
}

**Properties**

<table class="featureTable sort_table" summary="">




          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d565514e132">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d565514e135">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d565514e138">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d565514e141">Required</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">activatedDate</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">Date</td>

              <td class="entry" headers="d565514e138" data-title="Description">Date when the email template becomes active.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">attachmentObjectTypes</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">List&lt;String&gt;</td>

              <td class="entry" headers="d565514e138" data-title="Description">List of object types for attachments.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">automatedEmailActionType</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Action type for automated emails. Possible values are: <a name="ul_xpg_yzx_4gc"><!-- --></a>
                <ul class="ul bulletList" id="ul_xpg_yzx_4gc">
                  <li class="li"><samp class="codeph nolang">Create</samp></li>

                  <li class="li"><samp class="codeph nolang">Update</samp></li>

                  <li class="li"><samp class="codeph nolang">Cancel</samp></li>

                </ul>

              </td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">automatedEmailContextType</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Context type for automated emails. Possible values are: <a name="ul_wpg_yzx_4gc"><!-- --></a>
                <ul class="ul bulletList" id="ul_wpg_yzx_4gc">
                  <li class="li"><samp class="codeph nolang">ProviderVisit</samp></li>

                  <li class="li"><samp class="codeph nolang">Meeting</samp></li>

                </ul>

              </td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">bccEmailIdList</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Email ID for BCC.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">communicationSubscriptionId</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">ID of the communication subscription associated with the email
                temaplate.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">contentDocumentId</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">ID of the content document ZIP containing the email files. You can pass
                this parameter if you wish to process the existing document record. You cannot
                provide this parameter when you pass the <samp class="codeph nolang">fileId</samp>.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">customFields</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">Object</td>

              <td class="entry" headers="d565514e138" data-title="Description">Map of custom field names and their values for the email
                template.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">deactivatedDate</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">Datetime</td>

              <td class="entry" headers="d565514e138" data-title="Description">Date when the email template becomes inactive.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">description</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Description of the email template.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">emailSubject</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Subject line of the email template.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Required, only if the file input is provided either as <samp class="codeph nolang">contentDocumentId</samp> or <samp class="codeph nolang">fileId</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">fileId</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">The multipart form field key that references the uploaded file for this
                presentation page. You can pass this parameter if you wish to process a new
                file that you will include in the request. You cannot provide this parameter
                when you pass the <samp class="codeph nolang">contentDocumentId</samp> as
                only one of the two are allowed.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">id</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">ID of the email template. Either the <samp class="codeph nolang">SourceSystemIdentifier</samp> or Salesforce ID of the <samp class="codeph nolang">LifeSciEmailTemplate</samp> record.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Required</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">isActive</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">Boolean</td>

              <td class="entry" headers="d565514e138" data-title="Description">Indicates if the email template is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">isDefaultAutoEmailTemplate</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">Boolean</td>

              <td class="entry" headers="d565514e138" data-title="Description">Indicates if this is a default automated email template (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">isSubjectLineEditable</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">Boolean</td>

              <td class="entry" headers="d565514e138" data-title="Description">Indicates if the email subject line is editable (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">languages</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">List&lt;String&gt;</td>

              <td class="entry" headers="d565514e138" data-title="Description">List of languages associated with the email template as per the ISO codes
                such as <samp class="codeph nolang">en_US</samp>, <samp class="codeph nolang">fr</samp>, <samp class="codeph nolang">es</samp>.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">name</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Name of the email template.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">productId</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">ID of the associated product.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">replyToEmailAddress</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Reply-to email address.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">replyToType</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Type of reply-to address. Possible values are: <a name="ul_eqm_nvx_4gc"><!-- --></a>
                <ul class="ul bulletList" id="ul_eqm_nvx_4gc">
                  <li class="li"><samp class="codeph soql">SalesRep</samp></li>

                  <li class="li"><samp class="codeph soql">PredefinedEmail</samp></li>

                </ul>

              </td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">senderEmailFieldAPIName</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">API name of the sender's email field.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">senderType</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">Type of sender for the email. Possible values are: <a name="ul_vpg_yzx_4gc"><!-- --></a>
                <ul class="ul bulletList" id="ul_vpg_yzx_4gc">
                  <li class="li"><samp class="codeph soql">SalesRep</samp></li>

                  <li class="li"><samp class="codeph soql">PredefinedEmail</samp></li>

                </ul>

              </td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">shouldIgnoreEmailConsent</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">Boolean</td>

              <td class="entry" headers="d565514e138" data-title="Description">Indicates whether email consent should be ignored (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">surveyId</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">String</td>

              <td class="entry" headers="d565514e138" data-title="Description">ID of the associated survey.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

            <tr>
              <td class="entry" headers="d565514e132" data-title="Property Name"><samp class="codeph nolang">topics</samp></td>

              <td class="entry" headers="d565514e135" data-title="Type">List&lt;String&gt;</td>

              <td class="entry" headers="d565514e138" data-title="Description">List of topics associated with the email template. <samp class="codeph nolang">TopicAssignment</samp> for Life Science <samp class="codeph nolang">EmailTemplate</samp> must be enabled before using this
                field.</td>

              <td class="entry" headers="d565514e141" data-title="Required">Optional</td>

            </tr>

          </tbody>

        </table>

## Response Body for PATCH

[Update Email Template Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_content_management_output.htm "Represents the information about the job status and any associated messages returned for Content Management APIs.")