> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Notification Service Email Templates

## Email Templates

The table outlines the use case scenarios and relevant templates that can be implemented depending on your organization's needs. Each email template contains a header file (txt) and a body file (html).

| Use Case | Description | Email Templates | Variables |
| - | - | - | - |
| **General verification of authentication identifier with OTP** | This notification is sent to users to verify their authentication identifiers using an OTP. | - general-verification-of-authentication-identifier-with-otp\_header.txt - general-verification-of-authentication-identifier-with-otp\_body.html | - displayName - authnIdentifier - customToken |
| **2FA backup code is used** | This notification is sent to users when a 2FA backup code is entered to login. | - 2fa-backup-code-is-used\_header.txt - 2fa-backup-code-is-used\_body.html | - displayName |
| **Confirmation of deregistering an authentication identifier as MFA** | This notification is sent to users when they have successfully deregistered an authentication identifier as MFA. | - confirmation-of-deregistering-an-authentication-identifier-as-mfa\_header.txt - confirmation-of-deregistering-an-authentication-identifier-as-mfa\_body.html | - displayName - type - authnIdentifier |
| **Confirmation of activating authentication identifier** | This notification is sent to users when their authentication identifier is successfully activated. | - confirmation-of-activating-authentication-identifier\_header.txt - confirmation-of-activating-authentication-identifier\_body.html | - displayName - destination - newAuthnIdentifier |
| **Creation of regular User by Admin** | This notification is sent to users when an admin creates their User ID (account) in Storefront Gateway. **Note:** MFA is enabled and user's secondary factor is registered with this process. | - creation-of-regular-user-by-admin\_header.txt - creation-of-regular-user-by-admin\_body.htm | - displayName - actionTokenURL - destination - primaryAuthnIdentifier - secondaryAuthnIdentifier - MFAType - MFAAuthnIdentifier |
| **Update password notification for admin user** | This notification is sent to admin users after their password is updated. | - update-password-notification-for-admin-user\_header.txt - update-password-notification-for-admin-user\_body.html | - displayName - authnIdentifier |
| **Notification that transaction renewal was successful** | This notification is sent to users to notify them that their payment transaction renewal was successful. | - notification-that-transaction-renewal-was-successful\_header.txt - notification-that-transaction-renewal-was-successful\_body.html | - displayName - authnIdentifier - subscriptionDisplayName - subscriptionPrice - subscriptionCurrency - calendars.format(nextSubscriptionBillingDate\_calendar |
| **Notification of Maximum 2FA Retries** | This notification is sent to users when they exceed the maximum number of 2FA retries. | - notification-of-maximum-2fa-retries\_header.txt - notification-of-maximum-2fa-retries\_body.html | - displayName - retries |
| **2FA backup codes generated** | This notification is sent to users when a new set of backup codes have been generated for their User ID (account). | - 2fa-backup-codes-generated\_header.txt - 2fa-backup-codes-generated\_body.html | - displayName |
| **Notification of suspension after maximum number of failed login attempts** | This notification is sent to users when their user account has been suspended after reaching the maximum number of invalid login attempts. | - notification-of-suspension-after-maximum-number-of-failed-login-attempts\_header.txt - notification-of-suspension-after-maximum-number-of-failed-login-attempts\_body.html | - displayName - lockedUntil\_calendar |
| **Verification of email or mobile during onboarding with social account** | This notification is sent to users to verify their authentication identifiers during onboarding with social account process. | - verification-of-email-or-mobile-during-onboarding-with-social-account\_header.txt - verification-of-email-or-mobile-during-onboarding-with-social-account\_body.html | - displayName - providerId |
| **Notification that subscription was cancelled** | This notification is sent to users when their SLM subscription is cancelled. | - notification-that-subscription-was-cancelled\_header.txt - notification-that-subscription-was-cancelled\_body.html | - displayName - subscriptionDisplayName - calendars.format(subscriptionEnds\_calendar |
| **Notification sent to primary user after user declines invitation** | This notification informs the sender, either an admin or primary user, that the invited user declined the invitation. | - notification-sent-to-primary-user-after-a-user-declines-invitation\_header.txt - notification-sent-to-primary-user-after-a-user-declines-invitation\_body.html | - displayName - admindisplayName - shareEntities (service name) |
| **Confirmation of associating social account** | This notification will be sent to users when they have successfully associated their social account. | - confirmation-of-associating-social-account\_header.txt - confirmation-of-associating-social-account\_body.html | - displayName - providerId |
| **Invitation to join service** | This notification is sent to a user inviting them to share services with the originating user (sender). | - invitation-to-join-service\_header.txt - invitation-to-join-service\_body.html | - displayName - autnIdentifier - needsOnboarding - invitingUser - shareEntities |
| **Verification of admin user's email using machine provisioning** | This notification is sent to admin users, during the initial machine provisioning process, to verify their email address. | - verification-of-admin-user's-email\_header.txt - verification-of-admin-user's-email\_body.html | - displayName - longTokenExpirationPeriod - longTokenExpirationPeriodUnit |
| **Notification that transaction attempt was successful** | This notification is sent to users to notify them that their transaction attempt was successful. | - notification-that-transaction-attempt-succeeded.\_header.txt - notification-that-transaction-attempt-succeeded.\_body.html | - displayName - subscriptionDisplayName - subscriptionPrice - subscriptionCurrency - calendars.format(nextSubscriptionBillingDate\_calendar |
| **Notification that a credit card is about to expire or has expired already** | This notification is sent to users to notify them that the credit card used for account payment is expired or about to expire. | - notification-that-a-credit-card-is-about-to-expire-or-has-expired-already\_header.txt - notification-that-a-credit-card-is-about-to-expire-or-has-expired-already.\_body.html | - displayName - cc\_lastDigit |
| **Confirmation of registering an authentication identifier as MFA** | This notification is sent to users when they have successfully registered an authentication identifier as MFA. Message is sent to all verified authentication identifiers. | - confirmation-of-registering-an-authentication-identifier-as-mfa\_header.txt - confirmation-of-registering-an-authentication-identifier-as-mfa\_body.html | - displayName - type - authnIdentifier |
| **Confirmation of updating the preferred notification channel** | This notification is sent to users when their preferred notification channel is successfully updated. | - confirmation-of-updating-the-preferred-notification-channel\_header.txt - confirmation-of-updating-the-preferred-notification-channel\_body.html | - displayName - updatedContactChannel |
| **Verify admin user during password recovery process** | This notification is sent to admin users to verify them during the password recovery process. | - verify-admin-user-during-password-recovery-process\_header.txt - verify-admin-user-during-password-recovery-process\_body.html | - displayName - adminUILoginLink - longTokenExpirationPeriod - longTokenExpirationPeriodUnit |
| **Verification of authentication identifier during onboard user by email or mobile** | This notification is sent to users to verify their authentication identifiers during onboarding by email or mobile process. | - verification-of-authentication-identifier-during-onboarding\_header.txt - verification-of-authentication-identifier-during-onboarding\_body.html | - displayName - actionTokenURL - customToken |
| **Confirmation of onboarding with social account** | This notification will be sent to users when they have successfully onboarded with their social account. | - confirmation-of-onboarding-with-social-account\_header.txt - confirmation-of-onboarding-with-social-account\_header.txt | - displayName - providerId |
| **Notification before the renewal payment** | This notification is sent to users to notify them about their upcoming renewal payment that will be charged to the credit card registered on file. | - notification-before-the-renewal-payment.\_header.txt - notification-before-the-renewal-payment.\_body.html | - displayName - calendars.format(nextSubscriptionBillingDate\_calendar |
| **Verification of authentication identifier during onboarding using link** | This notification is sent to users to verify their authentication identifiers during the onboarding process. | - verification-of-authentication-identifier- during-onboarding- using-link\_header.txt - verification-of-authentication-identifier- during-onboarding- using-link\_body.html | - displayName - actionTokenURL |
| **Notification of the user deletion process has been completed** | This notification is sent to users to inform them that the user deletion process has completed and their Storefront Gateway ID has been deleted. | - notification-of-the-user-deletion-process-has-been-completed.\_header.txt - notification-of-the-user-deletion-process-has-been-completed..\_body.html | - displayName - authnIdentifier |
| **Verification of Authentication Identifier during log-in process** | This notification is sent to users to verify their authentication identifiers during the log-in process. | - verification-of-authentication-identifier-during-log-in-process\_header.txt - verification-of-authentication-identifier-during-log-in-process\_body.html | - displayName - actionTokenURL - customToken |
| **Confirmation of removing user attribute** | This notification is sent to users when they've successfully removed an attribute. The notification is sent to the authentication identifier that's set as the user's preferred notification channel (PNC). | - confirmation-of-removing-user-attribute\_header.txt - confirmation-of-removing-user-attribute\_body.html | - attributeName |
| **Verification of authentication identifier when adding or updating it** | This notification is sent to users to verify their authentication identifiers when adding or updating an authentication identifier. | - verification-of-authentication-identifier-when-adding-or-updating-it\_header.txt - verification-of-authentication-identifier-when-adding-or-updating-it\_body.html | - displayName - actionTokenURL - customToken - newAuthnIdentifier - oldAuthnIdentifier |
| **Notification sent to primary user after user accepts invitation** | This notification informs admin or primary users that the invited user accepted the invitation to share services. | - notification-sent-to-primary-user-after-a-user-accepts-invitation\_header.txt - notification-sent-to-primary-user-after-a-user-accepts-invitation\_body.html | - displayName - admindisplayName - shareEntities |
| **CSR agent notification about impersonation reply** | This notification informs the CSR about a user's reply to the CSR's impersonation request. If the user agrees (yes), the CSR can perform actions on behalf of that user. | - csr-agent-notification-about-impersonation-reply\_header.txt - csr-agent-notification-about-impersonation-reply\_body.html | - displayName - userId - actions |
| **Notification that subscription was modified** | This notification is sent to users when their SLM subscription is modified. | - notification-that-subscription-was-modified\_header.txt - notification-that-subscription-was-modified\_body.html | - displayName - subscriptionDisplayName - subscriptionPrice - subscriptionCurrency - nextSubscriptionBillingDate\_calendar, - operation - nextSubscriptionBillingDate\_calendar |
| **Verification of the new authentication identifier** | This notification is sent to users to verify a new authentication identifier. | - verification-of-the-new-authentication-identifier\_header.txt - verification-of-the-new-authentication-identifier\_body.html | - displayName - customToken - actionTokenURL |
| **Confirmation of disassociating social account** | This notification will be sent to users when they have successfully dissociated their social account. | - confirmation-of-dissociating-social-account\_header.txt - confirmation-of-dissociating-social-account\_body.html | - displayName - providerId |
| **Confirmation of registering FIDO 2** | This notification is sent to users when they have successfully registered with FIDO 2. Message is sent to all verified authentication identifiers. | - onfirmation-of-registering-fido-2\_header.txt - confirmation-of-registering-fido-2\_body.html | - displayName |
| **Invitation to join service when onboarding and acceptance is not needed** | This notification is sent to the user when neither onboarding or acceptance is needed | - invitation-to-join-service-when-onboarding-and-acceptance-is-not-needed\_header.txt - invitation-to-join-service-when-onboarding-and-acceptance-is-not-needed\_body.html | - displayName - authnIdentifier - invitingUser - shareEntities |
| **Confirmation of replacing authentication identifier** | This notification is sent to the users' old authentication identifier when their authentication identifier is successfully updated. | - confirmation-of-replacing-authentication-identifier\_header.txt - confirmation-of-replacing-authentication-identifier\_body.html | - displayName - oldAuthnIdentifier - newAuthnIdentifier |
| **Notification sent to primary user after a user left the service** | This notification is sent to the primary users to inform them that another user has left the service. | - notification-sent-to-primary-user-after-a-user-left-the-service\_header.txt - notification-sent-to-primary-user-after-a-user-left-the-service\_body.html | - displayName - primaryUser - entity |
| **Verification of authentication identifier during 2FA Processes** | This notification is sent to users to verify their authentication identifiers during 2FA Processes | - verification-of-authentication-identifier-during-2fa-processes\_header.txt - verification-of-authentication-identifier-during-2fa-processes\_body.html | - customToken - displayName |
| **Verification of admin user's email** | This notification is sent to admin users to verify their email address. | - verification-of-admin-user's-email\_header.txt - verification-of-admin-user's-email\_body.html | - displayName - inviterDisplayName - adminUILoginLink - longTokenExpirationPeriod - longTokenExpirationPeriodUnit |
| **Notification that transaction attempt failed** | This notification is sent to users to notify them that their transaction attempt failed. | - notification-that-transaction-attempt-failed.\_header.txt - notification-that-transaction-attempt-failed.\_body.html | - displayName - subscriptionDisplayName - subscriptionPrice - subscriptionCurrency |
| **Notification sent to user after they are removed from a group** | This notification informs users that the admin or primary user removed them from a group. | - notification-sent-to-user-after-they-are-removed-from-a-group\_header.txt - notification-sent-to-user-after-they-are-removed-from-a-group\_body.html | - displayName - group - removedEntities |
| **Confirmation of password update** | This notification is sent to users when their password is successfully updated. The notification will be sent to the authentication identifier set as the user's Preferred Notification Channel. | - confirmation-of-password-update\_header.txt - confirmation-of-password-update\_body.html | - displayName |
| **Notification that subscription was created** | This notification is sent to users when their SLM subscription is initially created. | - notification-that-subscription-was-created\_header.txt - notification-that-subscription-was-created\_body.html | - displayName - subscriptionDisplayName - subscriptionPrice - subscriptionCurrency - nextSubscriptionBillingDate\_calendar |
| **Verification of identity during password recovery** | This notification is sent to users to verify the authentication identifiers they entered during the password reset process. | - verification-of-identity-during-password-recovery\_header.txt - verification-of-identity-during-password-recovery\_body.html | - displayName - actionTokenURL - customToken - authnId - authnType |
| **Notification of the user deletion process has started** | This notification is sent to users to inform them that the user deletion process has started and their Storefront Gateway ID has been deleted will be deleted. | - notification-of-the-user-deletion-process-has-been-started.\_header.txt - notification-of-the-user-deletion-process-has-been-started..\_body.html | - displayName - authnIdentifier |
| **Confirmation of registering an authenticator app as MFA** | This notification is sent to users when they have successfully registered an authenticator app as MFA. | - confirmation-of-registering-an-authenticator-app-as-mfa\_header.txt - confirmation-of-registering-an-authenticator-app-as-mfa\_body.html | - displayName |
| **Confirmation of associating an account** | This notification is sent to users when they have successfully associated an account with their user. | - confirmation-of-associating-an-account\_header.txt - confirmation-of-associating-an-account\_body.html | - displayName - accounts |
| **Verification of authentication identifier during onboarding using otp** | This notification is sent to users to verify their authentication identifiers during the authentication process. | - verification-of-authentication-identifier-during-onboarding-using-otp\_header.txt - verification-of-authentication-identifier-during-onboarding-using-otp\_body.html | - displayName - authnIdentifier - customToken |
| **Notification sent to user after revocation of service** | This notification informs the user that their services have been revoked by an admin or primary user. | - notification-sent-to-user-after-revocation-of-service\_header.txt - notification-sent-to-user-after-revocation-of-service\_body.html | - displayName - entities |
| **Verification of authentication identifier during account association process** | This notification is sent to users to verify their authentication identifiers during account association process. | - verification-of-authentication-identifier-during-account-association-process\_header.txt - verification-of-authentication-identifier-during-account-association-process\_body.html | - displayName - customToken |
| **Verify identity during device authorization flow** | This notification is sent to users to verify their identity during the device authorization flow. | - verify-identity-during-device-authorization-flow\_header.txt - verify-identity-during-device-authorization-flow\_body.html | - displayName - actionTokenURL |
| **Request for impersonation** | This notification is sent to users to consent to an impersonation by another user such as a CSR. The user may accept or decline the request. | - request-for-impersonation\_header.txt - request-for-impersonation\_body.html | - displayName - actionTokenURL |
| **Verification of the updated authentication identifier** | This notification is sent to users to verify the updated authentication identifiers. | - verification-of-the-updated-authentication-identifier\_header.txt - verification-of-the-updated-authentication-identifier\_body.html | - displayName - actionTokenURL - customToken - newAuthnIdentifier |
| **Verification of authentication identifier during account dissociation process** | This notification is sent to users when they have successfully dissociated an account with their user. | - verification-of-authentication-identifier-during-account-dissociation-process\_header.txt - verification-of-authentication-identifier-during-account-dissociation-process\_body.html | - displayName - accounts |
| **Notification sent to user after revocation of service** | This notification informs users that the admin or primary user has disassociated the service from them. | - notification-sent-to-user-after-revocation-of-service\_header.txt - notification-sent-to-user-after-revocation-of-service\_body.html | - displayName - entities |
| **Parent topic:**[Manage Email Templates](templatesEmail) | | | |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.