---
title: "Update an email template"
method: PUT
path: "/notifications/email-templates/{id}"
tags: ["Notifications"]
---

# Update an email template

`PUT /notifications/email-templates/{id}`

Updates an email template. This operation supports updating the email template for all event types.

## Path parameters

- `id` string, uuid, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string

## Request body

- PUTPublicEmailTemplateRequest
  - `active` boolean — The status of the email template.
  - `bccEmailAddress` string, email — Email bcc address.
  - `ccEmailAddress` string — Email cc address.
  - `ccEmailType` 'BillToContact' | 'SoldToContact' | 'ShipToContact' | 'SpecificEmails' | 'TenantAdmin' | 'BillToAndSoldToContacts' | 'RunOwner' | 'AllContacts' | 'InvoiceOwnerBillToContact' | 'InvoiceOwnerSoldToContact' | 'InvoiceOwnerShipToContact' | 'InvoiceOwnerBillToAndSoldToContacts' | 'InvoiceOwnerAllContacts' — Email CC type. - When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts - When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - When the related event is tenant-level, such as Bill Run Completion, you can use the following values: - TenantAdmin - RunOwner - SpecificEmails
  - `description` string — The description of the email template.
  - `emailBody` string — The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see <a href="https://docs.zuora.com?resourceId=platform-merge-field-syntax" target="_blank">Merge field syntax for email templates</a>. User can also embed html tags if `isHtml` is `true`.
  - `emailHeaders` object — Container for custom email headers. Each custom email header consists of a header name and a header value.
  - `emailSubject` string — The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see <a href="https://docs.zuora.com?resourceId=platform-merge-field-syntax" target="_blank">Merge field syntax for email templates</a>.
  - `encodingType` 'UTF8' | 'Shift_JIS' | 'ISO_2022_JP' | 'EUC_JP' | 'X_SJIS_0213' — The endcode type of the email body.
  - `fromEmailAddress` string — If fromEmailType is SpecificEmail, this field is required
  - `fromEmailType` 'TenantEmail' | 'RunOwner' | 'SpecificEmail' — The type of fromEmail.
  - `fromName` string — The name of email sender.
  - `isHtml` boolean — Indicates whether the style of email body is HTML.
  - `name` string — The name of the email template.
  - `replyToEmailAddress` string — If replyToEmailType is SpecificEmail, this field is required.
  - `replyToEmailType` 'TenantEmail' | 'RunOwner' | 'SpecificEmail' — The type of the reply email.
  - `toEmailAddress` string — If toEmailType is SpecificEmail, this field is required.
  - `toEmailType` 'BillToContact' | 'SoldToContact' | 'ShipToContact' | 'SpecificEmails' | 'TenantAdmin' | 'BillToAndSoldToContacts' | 'RunOwner' | 'AllContacts' | 'InvoiceOwnerBillToContact' | 'InvoiceOwnerSoldToContact' | 'InvoiceOwnerShipToContact' | 'InvoiceOwnerBillToAndSoldToContacts' | 'InvoiceOwnerAllContacts' — Email receive type. - When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts - When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - When the related event is tenant-level, such as Bill Run Completion, you can use the following values: - TenantAdmin - RunOwner - SpecificEmails

## Response `200`

OK

- GETPublicEmailTemplateResponse
  - `active` boolean — The status of the email template.
  - `bccEmailAddress` string, email — Email BCC address.
  - `ccEmailAddress` string — Email CC address.
  - `ccEmailType` 'BillToContact' | 'SoldToContact' | 'ShipToContact' | 'SpecificEmails' | 'TenantAdmin' | 'BillToAndSoldToContacts' | 'RunOwner' | 'AllContacts' | 'InvoiceOwnerBillToContact' | 'InvoiceOwnerSoldToContact' | 'InvoiceOwnerShipToContact' | 'InvoiceOwnerBillToAndSoldToContacts' | 'InvoiceOwnerAllContacts' — Email cc type.
  - `createdBy` string, uuid — The ID of the user who created the email template.
  - `createdOn` string, date-time — The time when the email template was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00
  - `description` string — The description of the email template.
  - `emailBody` string — The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see <a href="https://docs.zuora.com?resourceId=platform-merge-field-syntax" target="_blank">Merge field syntax for email templates</a>. User can also embed html tags if `isHtml` is `true`.
  - `emailHeaders` object — Container for custom email headers. Each custom email header consists of a header name and a header value.
  - `emailSubject` string — The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see <a href="https://docs.zuora.com?resourceId=platform-merge-field-syntax" target="_blank">Merge field syntax for email templates</a>.
  - `encodingType` 'UTF8' | 'Shift_JIS' | 'ISO_2022_JP' | 'EUC_JP' | 'X_SJIS_0213' — The endcode type of the email body.
  - `eventCategory` number — The event category code for a standard event. See [Standard Event Categories](https://docs.zuora.com?resourceId=platform-parent-and-event-category-code) for all event category codes.
  - `eventTypeName` string — The name of the custom event or custom scheduled event.
  - `eventTypeNamespace` string — The namespace of the `eventTypeName` field for custom events and custom scheduled events.
  - `fromEmailAddress` string — If formEmailType is SpecificEmail, this field is required.
  - `fromEmailType` 'TenantEmail' | 'RunOwner' | 'SpecificEmail' — The from email type.
  - `fromName` string — The name of email sender.
  - `id` string, uuid — The email template ID.
  - `isHtml` boolean — Indicates whether the style of email body is HTML.
  - `name` string — The name of the email template.
  - `replyToEmailAddress` string — If replyToEmailType is SpecificEmail, this field is required
  - `replyToEmailType` 'TenantEmail' | 'RunOwner' | 'SpecificEmail' — The reply email type.
  - `toEmailAddress` string — If `toEmailType` is `SpecificEmail`, this field is required.
  - `toEmailType` 'BillToContact' | 'SoldToContact' | 'ShipToContact' | 'SpecificEmails' | 'TenantAdmin' | 'BillToAndSoldToContacts' | 'RunOwner' | 'AllContacts' | 'InvoiceOwnerBillToContact' | 'InvoiceOwnerSoldToContact' | 'InvoiceOwnerShipToContact' | 'InvoiceOwnerBillToAndSoldToContacts' | 'InvoiceOwnerAllContacts' — Email receive type.
  - `updatedBy` string, uuid — The ID of the user who updated the email template.
  - `updatedOn` string, date-time — The time when the email template was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `405` — Method Not Allowed
- `415` — Unsupported Media Type
- `500` — Internal Server Error

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)