Sign in
Notifications

Create an email template

Creates an email template.

This operation supports creating the email template for all event types.

  • If you specify the eventCategory field, the email template is created based on a standard event. See Standard Event Categories for all standard event category codes.
  • If you specify the eventTypeName field, the email template is created based on the corresponding custom event or custom scheduled event. See Custom event triggers for more information about custom events, and Custom scheduled events for more information about custom scheduled events.
post/notifications/email-templates

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request body

activeboolean

The status of the email template. The default value is true.

bccEmailAddressstring email

The email bcc address.

ccEmailAddressstring

The 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
descriptionstring

The description of the email template.

emailBodystring required

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>.

You can also embed HTML tags if isHtml is true.

emailHeadersobject

Container for custom email headers. Each custom email header consists of a header name and a header value.

emailSubjectstring required

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.

eventCategorynumber

If you specify this field, the email template is created based on a standard event. See Standard Event Categories for all standard event category codes.

eventTypeNamestring

The name of the custom event or custom scheduled event. If you specify this field, the email template is created based on the corresponding custom event or custom scheduled event.

eventTypeNamespacestring

The namespace of the eventTypeName field. The eventTypeName has the user.notification namespace by default.

Note that if the eventTypeName is a standard event type, you must specify the com.zuora.notification namespace; otherwise, you will get an error.

For example, if you want to create an email template on the OrderActionProcessed event, you must specify com.zuora.notification for this field.

fromEmailAddressstring

If fromEmailType is SpecificEmail, this field is required.

fromEmailType'TenantEmail' | 'RunOwner' | 'SpecificEmail' required

The type of the email.

fromNamestring

The name of the email sender.

isHtmlboolean

Indicates whether the style of email body is HTML. The default value is false.

namestring required

The name of the email template, a unique name in a tenant.

replyToEmailAddressstring

If replyToEmailType is SpecificEmail, this field is required.

replyToEmailType'TenantEmail' | 'RunOwner' | 'SpecificEmail'

Type of the replyTo email.

toEmailAddressstring

If toEmailType is SpecificEmail, this field is required.

toEmailType'BillToContact' | 'SoldToContact' | 'ShipToContact' | 'SpecificEmails' | 'TenantAdmin' | 'BillToAndSoldToContacts' | 'RunOwner' | 'AllContacts' | 'InvoiceOwnerBillToContact' | 'InvoiceOwnerSoldToContact' | 'InvoiceOwnerShipToContact' | 'InvoiceOwnerBillToAndSoldToContacts' | 'InvoiceOwnerAllContacts' required

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

Example request

{
  "name": "Account Edit Email",
  "eventTypeName": "AccountEdit",
  "active": true,
  "fromName": "Company Co. Ltd.",
  "fromEmailType": "TenantEmail",
  "toEmailType": "BillToContact",
  "replyToEmailType": "TenantEmail",
  "emailSubject": "Account {{DataSource.Account.AccountNumber}} has been edited",
  "emailBody": "Dear user,<p>the account {{DataSource.Account.AccountNumber}} has been edited. <p>Company Co. Ltd."
}

Response

OK

activeboolean

The status of the email template.

bccEmailAddressstring email

Email BCC address.

ccEmailAddressstring

Email CC address.

ccEmailType'BillToContact' | 'SoldToContact' | 'ShipToContact' | 'SpecificEmails' | 'TenantAdmin' | 'BillToAndSoldToContacts' | 'RunOwner' | 'AllContacts' | 'InvoiceOwnerBillToContact' | 'InvoiceOwnerSoldToContact' | 'InvoiceOwnerShipToContact' | 'InvoiceOwnerBillToAndSoldToContacts' | 'InvoiceOwnerAllContacts'

Email cc type.

createdBystring uuid

The ID of the user who created the email template.

createdOnstring 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

descriptionstring

The description of the email template.

emailBodystring

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.

emailHeadersobject

Container for custom email headers. Each custom email header consists of a header name and a header value.

emailSubjectstring

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.

eventCategorynumber

The event category code for a standard event. See Standard Event Categories for all event category codes.

eventTypeNamestring

The name of the custom event or custom scheduled event.

eventTypeNamespacestring

The namespace of the eventTypeName field for custom events and custom scheduled events.

fromEmailAddressstring

If formEmailType is SpecificEmail, this field is required.

fromEmailType'TenantEmail' | 'RunOwner' | 'SpecificEmail'

The from email type.

fromNamestring

The name of email sender.

idstring uuid

The email template ID.

isHtmlboolean

Indicates whether the style of email body is HTML.

namestring

The name of the email template.

replyToEmailAddressstring

If replyToEmailType is SpecificEmail, this field is required

replyToEmailType'TenantEmail' | 'RunOwner' | 'SpecificEmail'

The reply email type.

toEmailAddressstring

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.

updatedBystring uuid

The ID of the user who updated the email template.

updatedOnstring 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

Example response

{
  "id": "f11e498862584a10a05b83ea70119659",
  "createdBy": "8ad084a67f9c7138017fab8a8b511b5a",
  "createdOn": "2024-11-06T09:24:07.000 UTC",
  "updatedBy": "8ad084a67f9c7138017fab8a8b511b5a",
  "updatedOn": "2024-11-06T09:24:07.000 UTC",
  "eventTypeNamespace": "user.notification",
  "eventTypeName": "AccountEdit",
  "name": "Account Edit Email",
  "description": "",
  "encodingType": "UTF8",
  "fromName": "Company Co. Ltd.",
  "fromEmailType": "TenantEmail",
  "fromEmailAddress": "",
  "replyToEmailType": "TenantEmail",
  "replyToEmailAddress": "",
  "ccEmailType": "SpecificEmails",
  "ccEmailAddress": "",
  "bccEmailAddress": "",
  "toEmailType": "BillToContact",
  "toEmailAddress": "",
  "emailHeaders": {},
  "emailSubject": "Account {{DataSource.Account.AccountNumber}} has been edited",
  "emailBody": "Dear user,<p>the account {{DataSource.Account.AccountNumber}} has been edited. <p>Company Co. Ltd.",
  "fileId": "",
  "active": true,
  "isHtml": false,
  "useAdditionalAddresses": false
}

Changes