--- title: Customize emails description: "Estimated time to complete: 20 minutes" component: pingoneaic page_id: pingoneaic:use-cases:use-case-email-template canonical_url: https://docs.pingidentity.com/pingoneaic/use-cases/use-case-email-template.html keywords: ["Implementation Guide", "Use Case", "Customization"] page_aliases: ["implementation:use-case-customize-email-template.adoc"] section_ids: emails-description: Description emails-goals: Goals emails-prereqs: Prerequisites emails-tasks: Tasks emails-tasks-1: "Task 1: Create a new user registration email template" emails-duplicate-email: Duplicate the default user registration email emails-customize-email: Customize the new email template emails-tasks-2: "Task 2: Update the user registration journey" emails-validation: Validation emails-validation-steps: Steps emails-video: Video emails-explore-further: Explore further emails-reference-material: Reference material --- # Customize emails ## Description Estimated time to complete: 20 minutes *(tooltip: This assumes you complete the prerequisites beforehand.)* In this use case, you: * Duplicate the default registration email * Customize the duplicated email to match your organization's branding * Add the new email template to the `User Registration` journey (you must complete the [User registration](use-case-user-registration.html) use case) * Register as a new end user to test the newly branded email ### Goals After completing this use case, you will know how to do the following: * Create new email templates * Update journeys to use different email templates ## Prerequisites Before you start work on this use case, ensure you have these prerequisites: * You have completed the [User registration](use-case-user-registration.html) use case * Access to your Advanced Identity Cloud development environment as an administrator * A basic understanding of journeys and nodes * A basic understanding of CSS ## Tasks ### Task 1: Create a new user registration email template | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | In your staging, UAT\[[1](#_footnotedef_1 "View footnote.")], and production tenant environments, you *must* update the [email provider configuration](../tenants/email-provider.html#configure-an-email-provider-across-your-tenant-environments) to use your own external email provider. | #### Duplicate the default user registration email 1. In the Advanced Identity Cloud admin console, go to [icon: mail, set=material, size=inline] Email > Templates. 2. On the Email Templates page, click the ellipsis icon ([icon: ellipsis-h, set=fa]) for the `Registration` template and select Duplicate. 3. In the Duplicate Template window, enter the following details: | Field | Value | | ------------- | --------------------------------------------------------------------- | | Template Name | `Branded Registration` | | From Address | Enter an email address for the group or individual sending the email. | | From Name | Enter a name for the group or individual sending the email. | | Description | `Branded version of the default Registration email.` | 4. Click Save. The email templates editor displays. #### Customize the new email template | | | | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | You can add images to your email template if they are hosted online. Learn more in [Add an image to an email template](../tenants/email-templates.html#add-email-template-images). | 1. In the email templates editor, make the following changes to the `Branded Registration` email template: | Change | Detail | | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | Update the heading text | Replace the heading text in line 1 with `Thank you for registering`.Leave the `#` characters. This indicates a heading, in this case, an H3 heading. | | Update the email verification link text | Update the email verification link text in line 3 to:``` To confirm your email address, click [verify email](<{{object.resumeURI}}>). ``` | 2. Click Save. 3. Click Styles to change the look and feel of the email template. Make the following changes: | Change | Detail | | ----------------------- | ---------------------------------------------------------------------------------- | | Update the font | Add `font-family:arial;` under *.content* to change the font used in the email. | | Change the link color | Change the color value under *a* to `#0C85CF`. | | Format the heading text | Add the following CSS to format the heading text:```css h3{ color:#324054 } ``` | ![Registration email preview](_images/use-case-customize-email-template/email-template-styles.png) 4. Click Save. The email preview shows the updated email template: ![Registration email preview](_images/use-case-customize-email-template/register-email-preview.png) 5. In the URL, copy the email template name shown after /edit (`brandedRegistration`). You will need this in the next task. ![Email template name](_images/use-case-customize-email-template/email-template-name.png) | | | | - | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | | You can send yourself a test email to check everything looks correct before proceeding. Click Send Test Email, enter your email address, and click Send. | ### Task 2: Update the user registration journey In this task, you update the `User Registration` journey to use your new email template. 1. In the Advanced Identity Cloud admin console, go to [icon: account_tree, set=material, size=inline] Journeys. 2. Click the ellipsis icon ([icon: ellipsis-h, set=fa]) for the `Registration` journey and select Edit. 3. Click the Email Suspend Node and enter `brandedRegistration` in the Email Template Name field. The name you enter must exactly match the name shown in the URL when you customized the email template. 4. Click Save. Check in At this point, you: | | | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | | [icon: check, set=fa]Created a new email template for user registration. | [icon: check, set=fa]Customized the email to use your organization's font and colors. | | [icon: check, set=fa]Updated the User Registration journey to use your new email template. | | ## Validation Now that you have created a new email template for user registration and added it to the `User Registration` journey, you are ready to validate the email. The steps in this validation register a new end user in Advanced Identity Cloud so you can check they receive the branded email during the registration process. | | | | - | ---------------------------------------------------------------------------------------- | | | When you register the new end user, ensure you use an email address that you can access. | ### Steps 1. In the Advanced Identity Cloud admin console, go to [icon: account_tree, set=material, size=inline] Journeys and click on the `User Registration` journey you just updated. 2. In the Preview URL field, click [icon: copy, set=material, size=inline] and paste the URL into an incognito window. The Sign Up page for the tenant displays. 3. In the Sign Up page, enter the following details: | Field | Value | | ------------- | ------------------------------------------------------------------------------------- | | Username | `cbarnes` | | First Name | `Charlie` | | Last Name | `Barnes` | | Email Address | Enter an email address for this new user. You must have access to this email account. | 4. Click Next. A message displays informing you an email has been sent. 5. Check the inbox for the email address you entered and view the registration email. Confirm it has been branded as expected. 6. Click the link in the email to confirm your email address and continue registration. 7. Enter `Ch4ng3it!` in the Password field. 8. Click Next. You are signed on to the hosted account pages as Charlie Barnes. ### Video The following video displays the expected validation of registering a new end user using the updated email template: **Video (Brightcove)** \ ## Explore further ### Reference material | Reference | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | [Email templates](../tenants/email-templates.html) | Learn about creating, editing and managing email templates. | | [Use HTML formatting in an email template](../tenants/email-templates.html#email-template-html-formatting) | Steps for enhancing email templates in Advanced Identity Cloud with images and HTML formatting | | [Use ESV variables in an email template](../tenants/email-templates.html#email-template-esvs) | Steps for including Environment secrets and variables (ESVs) in email templates. | | [Manage email template locales](../tenants/email-templates.html#manage-email-template-locales) | Steps to send localized emails from a journey. | | [Journeys](../journeys/journeys.html) | Conceptual information on journeys and their purpose in Advanced Identity Cloud. | *** [1](#_footnoteref_1). A [user acceptance testing (UAT) environment](../tenants/environments-uat.html) is an [add-on capability](../product-information/add-on-capabilities.html).