Skip to content

Commit f3cd569

Browse files
paigecalvertpaigecalvert
committed
docs edits
1 parent e5e6f30 commit f3cd569

File tree

1 file changed

+41
-34
lines changed

1 file changed

+41
-34
lines changed

‎docs/vendor/enterprise-portal-configure.mdx‎

Lines changed: 41 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ To manage Enterprise Portal settings:
6161

6262
1. Click **Save**.
6363

64-
## Configure Invitation and Notification Emails {#configure-customer-emails}
64+
## Customize Customer Emails {#configure-customer-emails}
6565

66-
You can customize the the content and styling of the invitation and notification emails that are sent to your customers.
66+
### Configure Email Sender
6767

6868
To configure customer emails:
6969

@@ -76,51 +76,58 @@ To configure customer emails:
7676
1. For **Email Sender Verification**, in **From email address**, add the email address that you want to use as the sender for all system notifications sent to your customers, then click **Continue**. Adding a sender address helps ensure that your emails are delivered and are not marked as spam.
7777

7878
After the domain is verified automatically, the email address is displayed under **Verified Sender Address**.
79-
1. For **Customer Emails**, customize the subject line and body of the emails that are sent to your customers for various system events. Email templates support dynamic variables that are automatically populated with relevant data when emails are sent.
8079

81-
![Enterprise Portal edit emails pane](/images/enterprise-portal-customer-emails-edit.png)
80+
### Customize Email Templates
8281

83-
[View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png)
82+
You can customize the subject line, content, and styling of the emails that are sent to your customers.
8483

85-
To edit a template:
84+
To customize email templates:
8685

87-
1. Click the email type you want to customize to expand the template editor.
88-
1. Modify the **Subject line** and **Email body** fields.
89-
1. Use template variables (formatted as `{{variable_name}}`) to insert dynamic content.
90-
1. Check the **Available Variables** section below the email body editor to see which variables you can use for this specific email type.
91-
1. Click the **Preview** tab to see how your email will look with sample data.
92-
1. Click **Save changes** when finished.
86+
1. In the Vendor Portal, go to **Enterprise Portal > Customer Emails**.
87+
88+
![Enterprise Portal customer emails page](/images/enterprise-portal-customer-emails.png)
9389

94-
You can also customize the default style component to change things like color and font.
90+
[View a larger version of this image](/images/enterprise-portal-customer-emails.png)
9591

96-
### Using Template Variables
92+
1. For **Customer Emails**, first select the email category (such as **Access & Authentication** or **Update Notifications**). Then, select the name of the email template that you want to customize.
9793

98-
Variables are displayed in the UI under **Available Variables** when you expand an email template.
94+
The template editor opens.
9995

100-
:::info Check the UI for Available Variables
101-
Each email template has different variables available. When editing a template, look for the **Available Variables** section below the email body editor - it shows exactly which variables you can use for that specific email type.
102-
:::
96+
The following shows an example of the editor for the **Temporary Login Link** email template:
97+
98+
![Enterprise Portal edit emails pane](/images/enterprise-portal-customer-emails-edit.png)
99+
100+
[View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png)
101+
102+
1. In the editor, modify the subject line and body as desired. Note the following options:
103+
104+
* You can customize the default style component to change things like color and font.
105+
106+
* You can use template variables to insert dynamic content in the subject or body. For example, `Welcome to {{app_name}}!` or `Click here to join {{team_name}}: {{invite_url}}`. Template variables are automatically populated with relevant data when emails are sent.
107+
108+
:::note
109+
The specific template variables that are available for use depend on the type of email template that you are editing. You can see all available variables in the **Available Variables** section of the editor. For a list of the common template variables that are available across multiple email templates, see [Common Template Variables](#common-template-variables) below.
110+
:::
103111

104-
**Example usage:**
105-
- Subject: `Welcome to {{app_name}}!`
106-
- Body: `Click here to join {{team_name}}: {{invite_url}}`
112+
1. Click the **Preview** tab to see how your email will look with sample data.
107113

114+
1. Click **Save changes** when finished.
108115

109-
### Common Template Variables
116+
### Common Template Variables
110117

111-
The following variables are commonly available across multiple email types:
118+
The following template variables are available across multiple email types:
112119

113-
| Variable | Description | Example Output |
114-
|----------|-------------|----------------|
115-
| `{{app_name}}` | Your application name | "Acme Application" |
116-
| `{{team_name}}` | Customer team name | "Acme Corp" |
117-
| `{{customer_name}}` | Customer organization name | "Acme Corporation" |
118-
| `{{login_url}}` | Link to login page | https://portal.example.com/acme/login |
119-
| `{{invite_url}}` | Link to accept invitation | https://portal.example.com/acme/invite#token |
120-
| `{{verification_code}}` | Temporary verification code | "ABC123" |
121-
| `{{version_label}}` | Software version number | "1.2.3" |
122-
| `{{release_notes}}` | Release notes content | "New features and bug fixes" |
123-
| `{{update_url}}` | Link to update/release page | https://portal.example.com/acme/releases |
120+
| Variable | Description | Example Output |
121+
|----------|-------------|----------------|
122+
| `{{app_name}}` | Your application name | "Acme Application" |
123+
| `{{team_name}}` | Customer team name | "Acme Corp" |
124+
| `{{customer_name}}` | Customer organization name | "Acme Corporation" |
125+
| `{{login_url}}` | Link to login page | https://portal.example.com/acme/login |
126+
| `{{invite_url}}` | Link to accept invitation | https://portal.example.com/acme/invite#token |
127+
| `{{verification_code}}` | Temporary verification code | "ABC123" |
128+
| `{{version_label}}` | Software version number | "1.2.3" |
129+
| `{{release_notes}}` | Release notes content | "New features and bug fixes" |
130+
| `{{update_url}}` | Link to update/release page | https://portal.example.com/acme/releases |
124131

125132
## Add a Link to Documentation
126133

0 commit comments

Comments
 (0)