Customize Workflow Email
In brief
In the message body, you can customize the email text to personalize it for each recipient. You can optionally include built-in user attributes, custom security attributes, directory extensions, and on-premises extension attributes by embedding them in the te…
Documentation change
Format attributes within customized emails
To further personalize customized emails, you can take advantage of dynamic attributes. By placing dynamic attributes in your emails, you can specifically call out values such as a user's name, their generated Temporary Access Pass, or even their manager's email.
In the message body, you can customize the email text to personalize it for each recipient. You can optionally include built-in user attributes, custom security attributes, directory extensions, and on-premises extension attributes by embedding them in the text. Before the email is sent, the placeholders are replaced with the actual user information.
To use dynamic attributes within your customized emails, you must follow formatting rules. The proper format is:
To use dynamic attributes within your customized emails, you must follow formatting rules. The proper format for user attributes is:
{{dynamic attribute}}
{{user.graphPropertyName}}
The following screenshot is an example of the proper format for dynamic attributes within a customized email:
When you're typing a dynamic attribute, the email is written in the following way:
Welcome to the team, {{userGivenName}}
Welcome to the team, {{user.displayName}}
We're excited to have you join our growing team and look forward to a successful and memorable journey together.
The following table shows examples of the dynamic attributes available within emails:
| Attribute type | Examples |
|---|---|
| Built-in user attributes | {{user.displayName}}, {{user.userPrincipalName}}, {{user.employeeHireDate}}, {{user.employeeLeaveDateTime}}, {{user.createdDateTime}}, {{user.employeeType}}, {{user.department}}, {{user.companyName}}, {{user.jobTitle}} |
| Temporary Access Pass | {{temporaryAccessPass}} |
| Employee organizational data | {{user.employeeOrgData/costCenter}}, {{user.employeeOrgData/division}} |
| Custom security attributes | {{user.customSecurityAttributes/attributeSet/attribute}} |
| On-premises extension attributes | {{user.onPremisesExtensionAttributes/extensionAttribute1}} |
| Manager attributes | {{managerDisplayName}}, {{managerEmail}} |
For a full list of dynamic attributes that you can use with customized emails, see Dynamic attributes within email.
Use custom branding and domain in emails sent via workflows
diff --git a/docs/id-governance/customize-workflow-email.md b/docs/id-governance/customize-workflow-email.md
index ddc09a0715d..00f27b59e32 100644
--- a/docs/id-governance/customize-workflow-email.md
+++ b/docs/id-governance/customize-workflow-email.md
@@ -75,11 +75,11 @@ Emails sent by workflows can have their text customized to personalize, or stres
### Format attributes within customized emails
-To further personalize customized emails, you can take advantage of dynamic attributes. By placing dynamic attributes in your emails, you can specifically call out values such as a user's name, their generated Temporary Access Pass, or even their manager's email.
+In the message body, you can customize the email text to personalize it for each recipient. You can optionally include built-in user attributes, custom security attributes, directory extensions, and on-premises extension attributes by embedding them in the text. Before the email is sent, the placeholders are replaced with the actual user information.
-To use dynamic attributes within your customized emails, you must follow formatting rules. The proper format is:
+To use dynamic attributes within your customized emails, you must follow formatting rules. The proper format for user attributes is:
-`{{dynamic attribute}}`
+`{{user.graphPropertyName}}`
The following screenshot is an example of the proper format for dynamic attributes within a customized email:
@@ -88,7 +88,7 @@ The following screenshot is an example of the proper format for dynamic attribut
When you're typing a dynamic attribute, the email is written in the following way:
```html
-Welcome to the team, {{userGivenName}}
+Welcome to the team, {{user.displayName}}
We're excited to have you join our growing team and look forward to a successful and memorable journey together.
@@ -98,6 +98,17 @@ For more information and next steps, please contact your manager, {{managerDispl
```
+The following table shows examples of the dynamic attributes available within emails:
+
+| Attribute type | Examples |
+|---|---|
+| Built-in user attributes | `{{user.displayName}}`, `{{user.userPrincipalName}}`, `{{user.employeeHireDate}}`, `{{user.employeeLeaveDateTime}}`, `{{user.createdDateTime}}`, `{{user.employeeType}}`, `{{user.department}}`, `{{user.companyName}}`, `{{user.jobTitle}}` |
+| Temporary Access Pass | `{{temporaryAccessPass}}` |
+| Employee organizational data | `{{user.employeeOrgData/costCenter}}`, `{{user.employeeOrgData/division}}` |
+| Custom security attributes | `{{user.customSecurityAttributes/attributeSet/attribute}}` |
+| On-premises extension attributes | `{{user.onPremisesExtensionAttributes/extensionAttribute1}}` |
+| Manager attributes | `{{managerDisplayName}}`, `{{managerEmail}}` |
+
For a full list of dynamic attributes that you can use with customized emails, see [Dynamic attributes within email](lifecycle-workflow-tasks.md#dynamic-attributes-within-email).
## Use custom branding and domain in emails sent via workflows