Skip to content

Commit 59feaba

Browse files
committed
Customize Email updates
1 parent edea674 commit 59feaba

File tree

5 files changed

+265
-26
lines changed

5 files changed

+265
-26
lines changed
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: Customize emails sent out by workflow tasks
3+
description: A step by step guide for customizing emails sent out using tasks within Lifecycle Workflows
4+
author: owinfreyATL
5+
ms.author: owinfrey
6+
manager: amycolannino
7+
ms.service: active-directory
8+
ms.subservice: compliance
9+
ms.topic: how-to
10+
ms.date: 02/06/2023
11+
ms.custom: template-how-to
12+
---
13+
14+
# Customize emails sent out by workflow tasks (Preview)
15+
16+
Lifecycle Workflows provide many tasks related to sending emails to processed users. Email related tasks can be customized to suit the needs of a specific workflow. For a list of these tasks, see: [Lifecycle Workflows tasks and definitions (Preview)](lifecycle-workflow-tasks.md).
17+
18+
Emails sent out by these tasks can have the following information updated:
19+
20+
- CC information
21+
- Domain of sender
22+
- Branding associated with email
23+
- Subject
24+
- Message body
25+
- Email language translation
26+
27+
For more information on these customizable parameters, see: [Common email-specific task parameters](lifecycle-workflow-tasks.md#common-email-specific-task-parameters).
28+
29+
## Prerequisites
30+
31+
- Azure AD Premium P2
32+
33+
For more information, see: [License requirements](what-are-lifecycle-workflows.md#license-requirements)
34+
35+
To customize emails you must have the following:
36+
37+
- A verified domain. To add a custom domain, see: [Managing custom domain names in your Azure Active Directory](../enterprise-users/domains-manage.md)
38+
- Custom Branding set within Azure AD if you want to have your custom branding used in emails. To set organizational branding within your Azure tenant, see: [Configure your company branding (preview)](../fundamentals/how-to-customize-branding.md).
39+
40+
## Customize email using the Azure portal
41+
42+
When customizing an email sent via Lifecycle workflows, you can choose to customize either a new or existing task. These customizations are done the same way no matter if the task is new or existing, but the following steps walks you through updating an existing task. To customize emails sent out from tasks within workflows using the Azure portal, you'd follow these steps:
43+
44+
1. Sign in to the [Azure portal](https://portal.azure.com).
45+
46+
1. Type in **Identity Governance** in the search bar near the top of the page, and select it.
47+
48+
1. In the left menu, select **Lifecycle workflows (Preview)**.
49+
50+
1. In the left menu, select **workflows (Preview)**.
51+
52+
1. On the left side of the screen, select **Tasks (Preview)**.
53+
54+
1. On the tasks screen, select the task for which you want to customize the email.
55+
56+
1. On the specific task screen you are able to set CC to include others in the email outside of the default audience.
57+
58+
1. Select the **Email Customization** tab.
59+
60+
1. On the email customization screen, enter a custom subject, message body, and the email language translation option that will be used to translate the message body of the email.
61+
:::image type="content" source="media/customize-workflow-email/customize-workflow-email-example.png" alt-text="Example of a customized email from a workflow.":::
62+
1. After making changes, select **save** to capture changes to the customized email.
63+
64+
65+
## Format attributes within customized emails
66+
67+
To further personalize customized emails, you can take advantage of dynamic attributes. With dynamic attributes by placing in specific attributes, you're able to specifically call out values such as a user's name, their generated Temporary Access Pass, or even their manager's email.
68+
69+
To use dynamic attributes within your customized emails, you must follow the formatting rules within the customized email. The proper format is:
70+
71+
{{**dynamic attribute**}}
72+
73+
The following screenshot is an example of the proper format for dynamic attributes within a customized email:
74+
75+
:::image type="content" source="media/customize-workflow-email/workflow-dynamic-attribute-example.png" alt-text="Example of dynamic attributes in customized emails.":::
76+
77+
When typing this it will be written the following way:
78+
79+
```html
80+
Welcome to the team, {{userGivenName}}
81+
82+
We're excited to have you join our growing team and look forward to a successful and memorable journey together.
83+
84+
We've already set up a few things to help you get started quickly and make your onboarding process as smooth as possible.
85+
86+
For more information and next steps, please contact your manager, {{managerDisplayName}}
87+
88+
```
89+
90+
For a full list of dynamic attributes that can be used with customized emails, see:[Dynamic attributes within email](lifecycle-workflow-tasks.md#dynamic-attributes-within-email).
91+
92+
93+
94+
95+
## Customize email using Microsoft Graph
96+
97+
To customize email using Microsoft Graph API see: [workflow: createNewVersion](/graph/api/identitygovernance-workflow-createnewversion).
98+
99+
## Next steps
100+
101+
- [Lifecycle Workflow tasks](lifecycle-workflow-tasks.md)
102+
- [Manage workflow versions](manage-workflow-tasks.md)
103+
104+

0 commit comments

Comments
 (0)