Create or update email templates

Creates email templates for standard or custom events if you do not specify email template IDs, or updates existing email templates if you specify valid email template IDs.

For each email template when you are creating email templates, whether the template is created for a standard event, a custom event, or a custom scheduled event is dependent on whether you specify the eventCategory or eventTypeName field.

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.

The maximum number of email templates that you can create or update by one call is 1,000.

Request

header Parameters

Idempotency-Key	string <= 255 characters 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-Encoding	string 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-Encoding	string 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.
Authorization required	string The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
Zuora-Track-Id	string <= 64 characters 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-Ids	string 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-Ids	string Comma separated IDs. If you have Zuora Multi-Org 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. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required

The request body to import or update email templates.

allowPartialSuccess	boolean When set to `false`, the call will fail if one or multiple instances fail to import, and a `200` response is returned if all email templates have been successfully updated. When set to `true`, a success (`200`) response is returned if one or more instances have imported successfully. All failed instances are also returned in the response.
	Array of objects (POSTCreateOrUpdateEmailTemplateRequestFormat) A container for email templates.

Responses

200

post/notifications/email-templates/import

Request samples

Payload
cURL

application/json

{"allowPartialSuccess": true,
"emailTemplates": [{"active": true,
"bccEmailAddress": "user@example.com",
"ccEmailAddress": "user@example.com",
"ccEmailType": "SpecificEmails",
"description": "Email when an account is edited",
"emailBody": "Dear user,<p>the account <Account.Name> has been edited. </p><p>Example Co. Ltd.</p>",
"emailHeaders": {"My-Header-1": "Header value 1",
"My-Header-2": "Header value 2"
},
"emailSubject": "Account <Account.Number> has been edited",
"encodingType": "UTF8",
"eventTypeName": "AccountEdit",
"fromEmailType": "TenantEmail",
"fromName": "Example Co. Ltd.",
"id": "8500105b9a1045019474652bd81c7ce5",
"isHtml": true,
"name": "Account Edit Email",
"replyToEmailType": "TenantEmail",
"toEmailAddress": "DummyEmailAddress@example.com",
"toEmailType": "SpecificEmails"
},
{"active": true,
"bccEmailAddress": "",
"ccEmailAddress": "user@example.com",
"ccEmailType": "SpecificEmails",
"description": "Updated Description",
"emailBody": "Dear <BillToContact.FirstName> <BillToContact.LastName>,\r\n\r\nA refund of <Refund.Amount> <Account.Currency> was processed against your credit memo on <Refund.Date>.\r\n\r\nYour new account unapplied credit memo amount is <Account.UnappliedCreditMemoAmount> <Account.Currency> and your account balance is <Account.Balance> <Account.Currency>.\r\n\r\nThank you for your business!",
"emailHeaders": {"My-Header-1": "Header value 1",
"My-Header-2": "Header value 2"
},
"emailSubject": "Your credit memo refund was successfully processed",
"encodingType": "UTF8",
"eventCategory": 2830,
"fromEmailAddress": "support@zuora.com",
"fromEmailType": "SpecificEmail",
"fromName": "Admin",
"isHtml": true,
"name": "Credit Memo Refund Processed Default Email Template",
"replyToEmailAddress": "support@zuora.com",
"replyToEmailType": "SpecificEmail",
"toEmailAddress": "",
"toEmailType": "BillToContact"
}
]
}

Response samples

application/json

{"reasons": [ ]
}