--- title: "Email Template Variables" slug: "email-template-variables" status: "update" updated: 2025-01-23T18:56:26Z published: 2025-01-23T18:56:26Z canonical: "support.smarteru.com/email-template-variables" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.smarteru.com/llms.txt > Use this file to discover all available pages before exploring further. # Email Template Variables Email template variables are built-in identifiers that when used in an [email template](/v1/docs/email-templates) or [snippet](/v1/docs/email-template-snippets) are replaced with their actual value. For example, the *course.name* variable will be replaced with the actual course name (e.g., Accounting 101) and the *user.fullname* variable will be replaced with the user's full name (e.g., Gary Carter). The variables are organized into the following categories: - [Account](/v1/docs/email-template-variables#account-variables) - [Certification](/v1/docs/email-template-variables#certification-variables) - [Course](/v1/docs/email-template-variables#course-variables) - [Email](/v1/docs/email-template-variables#email-variables) - [Enrollment](/v1/docs/email-template-variables#enrollment-variables) - [Group](/v1/docs/email-template-variables#group-variables) - [Learning Plan](/v1/docs/email-template-variables#learning-plan-variables) - [Login](/v1/docs/email-template-variables#login-variables) - [Miscellaneous](/v1/docs/email-template-variables#miscellaneous-variables) - [Snippet](/v1/docs/email-template-variables#snippet-variables) - [Subscription](/v1/docs/email-template-variables#subscription-variables) - [User](/v1/docs/email-template-variables#user-variables) - [Video](/v1/docs/email-template-variables#video-variables) ## Account Variables ### account.adminthemename The [account's theme for the admin interface](/v1/docs/account-general-information#theme). ### account.learnerthemename The default theme selected for the [user's dashboard set](/v1/docs/dashboard-set-main#default-theme). ### account.logo The [account's logo](/v1/docs/account-customization#logo). ### account.name The [account's name](/v1/docs/account-general-information#name). ### account.systemfromemail The ["From" email address for system-generated emails](/v1/docs/account-email-options#set-a-from-address-for-systemgenerated-emails). ### account.systemfromidentity The ["From" identity for system-generated emails](/v1/docs/account-email-options#set-a-from-address-for-systemgenerated-emails). ### account.unsubscribecontact The unsubscribe contact. For user-generated or system-generated emails, this displays the "From" address and identify for [system-](/v1/docs/account-email-options#set-a-from-address-for-systemgenerated-emails) and [user-generated emails](/v1/docs/account-email-options#set-a-from-address-for-usergenerated-emails). ### account.userfromemail The ["From" email address for user-generated emails](/v1/docs/account-email-options#set-a-from-address-for-usergenerated-emails). ### account.userfromidentity The ["From" identity for user-generated emails](/v1/docs/account-email-options#set-a-from-address-for-usergenerated-emails). ## Certification Variables ### certification.description The [certification's description](/v1/docs/certification-main#description). ### certification.name The [certification's name](/v1/docs/certification-main#name). ## Course Variables ### course.chaptername The [course chapter's name](/v1/docs/adding-an-online-course-chapter). ### course.courseid The [course's identifier](/v1/docs/online-course-main#course-id). ### course.description The [course's description](/v1/docs/online-course-main#description-required). ### course.name The [course's name](/v1/docs/online-course-main#name-required). ### course.pointsinfo If [points and rewards](/v1/docs/points-and-rewards) are [enabled for your account](https://support.smarteru.com/docs/account-settings#points-rewards), information about [point trackers](/v1/docs/course-points-and-rewards) associated with the course. The information includes the point tracker's name, points earned, expiration type, and expiration date. If licensing is enabled for the account, the licensing category and licensing reference ID are also included. ### course.quiztaskname The online course's quiz or task name. ### course.sessioncalendar Links to add the session's information to an Outlook, Google, or iCal calendar. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ### course.sessioncalendargoogle Link to add the session’s information to a Google calendar. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ### course.sessioncalendarical Link to add the session’s information to an iCal calendar. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ### course.sessioncalendaroutlook Link to add the session’s information to an Outlook calendar. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ### course.sessionenddate The course [session's end date](/v1/docs/instructor-led-session-session-details#end-date). If a session has multiple parts, this variable returns the end date of the first part. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ### course.sessionendtime The course [session's end time](/v1/docs/instructor-led-session-session-details#end-date). If a session has multiple parts, this variable returns the end time of the first part. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ### course.sessioninformation Information about a course's [session](/v1/docs/adding-a-session). This includes the session's start date, end date, and location, plus a link to add the session's information to an Outlook, Google, or iCal calendar. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays: > Session information will be available once all prerequisites are completed. ### course.sessionlink A link to the [session's information on the learner interface](/v1/docs/learner-interface-course-details-session-details). ### course.sessionlocation The course session's venue. If a session has multiple parts, this variable returns the information of the first part. The information returned will depend on the [session's type](/v1/docs/instructor-led-session-session-details#session-details-type): - Venue - The session's [venue](/v1/docs/instructor-led-session-session-details#venue), [room](/v1/docs/instructor-led-session-session-details#room), and [room location](/v1/docs/settings-rooms#location). - Webinar - The [webinar URL](/v1/docs/instructor-led-session-session-details#url). - Other - The text entered in the [**Other** setting](/v1/docs/instructor-led-session-session-details#otherspecific-settings) for the session. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ### course.sessionstartdate The course [session's start date](/v1/docs/instructor-led-session-session-details#start-date). If a session has multiple parts, this variable returns the start date of the first part. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ### course.sessionstarttime The course [session's start time](/v1/docs/instructor-led-session-session-details#start-date). If a session has multiple parts, this variable returns the start time of the first part. The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:  > [Not Available] ## Email Variables ### email.allquizzesmustpass The description of the [All Graded Quizzes Must Pass online course setting](/v1/docs/online-course-grading#all-graded-quizzes-must-pass). This variable is only available for the [Course Completion to Home Group or Custom Contact](/v1/docs/system-email-templates-course-emails-general) email type. The description will only display in the email if the [**All Graded Quizzes Must Pass** online course setting](/v1/docs/online-course-grading#all-graded-quizzes-must-pass) is checked. ### email.changes The changes made to a user's login credentials (i.e., email, employee ID, name, and password). This variable is only available for the [Login Credentials Changed](/v1/docs/system-email-templates-user-emails#login-credentials-changed) email type. ### email.chaptername The name of a chapter in a course. This variable is only available for the [Task Feedback](/v1/docs/system-email-templates-course-emails-online-and-scorm#task-feedback) email type. ### email.confirmationurl The link that allows a learner to confirm their session attendance. This variable is only available for the [Confirm Attendance](/v1/docs/system-email-templates-course-emails-instructor-led#confirm-attendance) email type. ### email.courseenrollmentlist A table of the learner's course enrollments that includes their progress, course due date, and number of days before the course due date. This variable is only available for the [Weekly Reminder to Learner](/v1/docs/system-email-templates-weekly-emails#weekly-reminder-to-learner) email type. ### email.coursenamelist The list of courses that the learner was enrolled in. This variable is only used when a learner receives an email about multiple course enrollments. This variable is only available for the [Course Enrollment](/v1/docs/system-email-templates-enrollment-emails#course-enrollment) email type. ### email.editedby The name of the person who modified the user’s login credentials. This variable is only available for the [Login Credentials Changed](/v1/docs/system-email-templates-user-emails#login-credentials-changed) email type. ### email.emailinstructorsubject Text indicating whether a user was added as an instructor to, or removed as an instructor from a session. This variable is only available for the [Session Instructor Notification](/v1/docs/system-email-templates-course-emails-instructor-led#session-instructor-notification) email type. ### email.enrolleremail The email address of the person who performed the enrollment. This variable is only available for the [Course Enrollment](/v1/docs/system-email-templates-enrollment-emails#course-enrollment) email type. ### email.enrollername The full name of the person who performed the enrollment. This variable is only available for the [Course Enrollment](/v1/docs/system-email-templates-enrollment-emails#course-enrollment) email type. ### email.evaluationurl The link to the course’s evaluation survey. This variable is only available for the [Course Completion](/v1/docs/system-email-templates-course-emails-general#course-completion) email type. ### email.groupcount The number of groups included in the Weekly Summary Report. This variable is only available for the [Weekly Summary Report](/v1/docs/system-email-templates-weekly-emails#weekly-summary-report) email type. ### email.homegroupreportingmessage This variable is only available for the [Weekly Summary Report](/v1/docs/system-email-templates-weekly-emails#weekly-summary-report) email type. Text explaining what metrics are included in the report. The text included with this variable will depend on the following account settings. - [**Enable Home Group Reporting**](/v1/docs/account-settings#enable-home-group-reporting) checked - Home group reporting is on, meaning that these metrics include all of your learners’ enrollments, regardless of the group they are in. - [**Course Manager Access** setting's](/v1/docs/account-settings#course-manager-access) *Report on Enrollments* option checked- Course manager reporting is on, meaning that these metrics include all enrollments for courses you manage. - [**Supervisor Access** setting's](/v1/docs/account-settings#supervisor-access) *Report on Supervisees* option checked - Supervisor reporting is on, meaning that these metrics include all enrollments for learners you supervise. ### email.inviteremail The email address of the person who sent the account invitation. This variable is only available for the [Account Invitation](/v1/docs/system-email-templates-account-emails#account-invitation) email type. ### email.invitername The full name of the person who sent the account invitation. This variable is only available for the [Account Invitation](/v1/docs/system-email-templates-account-emails#account-invitation) email type. ### email.messagetype The type of feedback (i.e., suggestion, feedback, bug). This variable is only available for the [Task Feedback](/v1/docs/system-email-templates-course-emails-online-and-scorm#task-feedback) email type. ### email.quizdetails The details of a learner's completed quiz attempt (i.e., time limit, number of questions, percent to pass, max attempts, and number of correct questions per attempt). This variable is only available for the [Task Completion](/v1/docs/system-email-templates-course-emails-online-and-scorm#task-completion-to-custom-contact) email type. ### email.quizquestiontext A quiz's question. This variable is only available for the [Task Feedback](/v1/docs/system-email-templates-course-emails-online-and-scorm#task-feedback) email type. ### email.reportdashboardgrid Tables that summarize last week's enrollments, the status of all enrollments, and status of learning plans and certifications for the group(s) included in the Weekly Summary Report. This variable is only available for the [Weekly Summary Report](/v1/docs/system-email-templates-weekly-emails#weekly-summary-report) email type. ### email.resultmessage Displays whether a learner passed or failed a course. Unlike the [enrollment.passfail variable](/v1/docs/email-template-variables#enrollmentpassfail), this variable displays a sentence. For example, "John Smith has just completed and passed the Team Management course within the Fina Shoes Academy (Demo) account." This variable is only available for the [Course Completion to Home Group or Custom Contact](/v1/docs/system-email-templates-course-emails-general) email type. ### email.reviewquizurl The link to the learner's completed quiz attempt details. This variable is only available for the [Quiz Graded](/v1/docs/system-email-templates-course-emails-online-and-scorm#quiz-graded) email type. ### email.senderemail The email address of the user sending the email. ### email.senderimage The [profile image of the user sending the email](/v1/docs/user-login-information#photo). ### email.sendername The full name of the user sending the email. ### email.subjectresultmessage Displays whether a learner completed a course. This variable is only available for the [Course Completion to Home Group or Custom Contact](/v1/docs/system-email-templates-course-emails-general) email type. ### email.troubleshootingguidetext The link to a troubleshooting guide for webinar registration failures. This variable is only available for the [Webinar Registration Failure Notification](/v1/docs/system-email-templates-course-emails-instructor-led#webinar-registration-failure-notification) email type. ### email.webinarfailures The number of webinar registration failures. This variable is only available for the [Webinar Registration Failure Notification](/v1/docs/system-email-templates-course-emails-instructor-led#webinar-registration-failure-notification) email type. ## Enrollment Variables ### enrollment.completiondate The date the learner completed the course. This variable is only available for the following email types: - [Enrollment Automation Report](/v1/docs/system-email-templates-enrollment-emails#enrollment-automation-report) - [Enrollment Process Complete](/v1/docs/system-email-templates-enrollment-emails#enrollment-process-complete) ### enrollment.duedate The course's due date. ### enrollment.duration The total amount of time the learner was in the course. ### enrollment.grade The learner's grade for the course. ### enrollment.group The name of the group in which the enrollment occurred. ### enrollment.groupid The ID of the group in which the enrollment occurred. ### enrollment.grouplogo The logo of the group in which the enrollment occurred. ### enrollment.learnerenrolledcourselist A list of the learner's course enrollments. This variable is only available for the [Course Enrollment Notification to Supervisor](/v1/docs/system-email-templates-enrollment-emails#course-enrollment-notification-to-supervisor) email type. ### enrollment.learnerenrolledsubscriptionlist A list of the learner's subscription enrollments. This variable is only available for the [Subscription Enrollment Notification to Supervisor](/v1/docs/system-email-templates-enrollment-emails#subscription-enrollment-notification-to-supervisor) email type. ### enrollment.passfail Displays *Passed* or *Failed* depending on whether the learner passed or failed the course. ### enrollment.points If [points and rewards](/v1/docs/points-and-rewards) are [enabled for your account](https://support.smarteru.com/docs/account-settings#points-rewards), the total number of points that the learner earned for the course enrollment. If multiple point trackers are associated with the course, this number includes points for all point trackers. ### enrollment.state The learner's course enrollment status. ### enrollment.startdate The date the learner started the course. ### enrollment.subscriptionvariantinfo The subscription information associated with the course enrollment. This information includes the subscription name, variant name, start date, end date, and expiration. ### enrollment.type The course type (i.e., online, SCORM, instructor-led). ## Group Variables ### group.groupid The [group's identifier](/v1/docs/group-group-information#group-id). ### group.name The [group's name](/v1/docs/group-group-information#name). ## Learning Plan Variables ### learningplan.fullstructure The learning plan and the certifications, requirements, courses, and actions assigned to it. For example: Learning Plan 01 - Certification 01 - Requirement 01 - Course 01 - Action 01 - Certification 02 - Requirement 02 - Course 02 - Action 02 ### learningplan.name The [learning plan's name](/v1/docs/learning-plan-main#name). ### learningplan.uptocertification The learning plan and the certifications assigned to it. For example: Learning Plan 01 - Certification 01 - Certification 02 ### learningplan.uptorequirement The learning plan and the certifications, and requirements assigned to it. For example: Learning Plan 01 - Certification 01 - Requirement 01 - Certification 02 - Requirement 02 ## Login Variables ### login.url The [login portal URL](/v1/docs/account-portals#default-portal). ### login.password The user's login password. The password will only be sent out as plain text with the initial [Account Invitation email](/v1/docs/system-email-templates-account-emails#account-invitation). Resending the Account Invitation email to the user obscures the password (i.e., ***** displays). The user's password will also be obscured when this variable is included in other email templates. ### login.userlogin The user's login (email or employee ID). ## Miscellaneous Variables ### misc.completiondate The date a course enrollment, subscription enrollment, or user import was completed. This variable is only available for the following email types: - [Enrollment Automation Report](/v1/docs/system-email-templates-enrollment-emails#enrollment-automation-report) - [Enrollment Process Complete](/v1/docs/system-email-templates-enrollment-emails#enrollment-process-complete) - [User Import Completed](/v1/docs/system-email-templates-user-emails#user-import-completed) ### misc.currentdatetime The current date and time. ### misc.headerlogo The logo displayed in the header. The logo displayed will depend on the [user's dashboard set](/v1/docs/dashboard-set-customization). ### misc.learnerdashboardcoursedetailsurl The link to a course for a learner. ### misc.message The custom message for the email. A custom message may be specified for the following email types: - [Task Feedback](/v1/docs/system-email-templates-course-emails-online-and-scorm#task-feedback) - [Missed Attendance](/v1/docs/system-email-templates-course-emails-instructor-led#missed-attendance) - [Session Changed](/v1/docs/system-email-templates-course-emails-instructor-led#session-changed) - [Session Instructor Notification](/v1/docs/system-email-templates-course-emails-instructor-led#session-instructor-notification) ### misc.numberrequested The number of requested enrollments when enrolling learners to courses and subscriptions, or the number of requested imports when importing users. This variable is only available for the following email types: - [Enrollment Process Complete](/v1/docs/system-email-templates-enrollment-emails#enrollment-process-complete) - [User Import Completed](/v1/docs/system-email-templates-user-emails#user-import-completed) ### misc.numbersuccessful The number of successful enrollments when enrolling learners to courses and subscriptions, or the number of successful imports when importing users. This variable is only available for the following email types: - [Enrollment Process Complete](/v1/docs/system-email-templates-enrollment-emails#enrollment-process-complete) - [User Import Completed](/v1/docs/system-email-templates-user-emails#user-import-completed) ### misc.numberunsuccessful The number of unsuccessful enrollments when enrolling learners to courses and subscriptions, or the number of unsuccessful imports when importing users. This variable is only available for the following email types: - [Enrollment Process Complete](/v1/docs/system-email-templates-enrollment-emails#enrollment-process-complete) - [User Import Completed](/v1/docs/system-email-templates-user-emails#user-import-completed) ### misc.requestdate The date a course enrollment, subscription enrollment, or import was requested. ### misc.requesterip The requester's IP address for password recovery or login credential change requests. ### misc.ziplocation The link for downloadable [course certificates](/v1/docs/online-course-customization#course-completion-certificate), [certification certificates](/v1/docs/certification-main#certificate), [Enrollment Reports](/v1/docs/enrollment-report), and [user import reports](/v1/docs/importing-users-user-import-report). This variable is only available for the following email types: - [Certification Completion to Custom Contact](/v1/docs/system-email-templates-certification-emails#certification-completion-to-custom-contact) - [Certification Completion to Home Group Contact](/v1/docs/system-email-templates-certification-emails#certification-completion-to-home-group-contact) - [Course Completion to Group Contact](/v1/docs/system-email-templates-course-emails-general#course-completion-to-group-contact) - [Enrollment Automation Report](/v1/docs/system-email-templates-enrollment-emails#enrollment-automation-report) - [Enrollment Process Complete](/v1/docs/system-email-templates-enrollment-emails#enrollment-process-complete) - [Queued Exports Notification](/v1/docs/system-email-templates-report-emails#queued-exports-notification) - [Requested Course Certificates](/v1/docs/system-email-templates-course-emails-instructor-led#requested-course-certificates) - [User Import Completed](/v1/docs/system-email-templates-user-emails#user-import-completed) When the misc.ziplocation variable is included in the [Course Completion to Group Contact](/v1/docs/system-email-templates-course-emails-general#course-completion-to-group-contact) email, the course certificate will only be available for download for 72 hours. If the learner's [dashboard set includes a page that displays completed courses](/v1/docs/page-configuration), the learner can also download the course certificate from the [course details page](/v1/docs/learner-interface-course-details-enrollment). ## Snippet Variables ### snippet.contactcard The [user's contact card](/v1/docs/user-contact-cards). ### snippet.defaultfooter The default footer that's displayed at the bottom of all emails: > This message was sent to *|user.email|* because you are a user of *|account.name|*. *|snippet.footerunsubscribemessage|* Delivered by *|login.loginurl|*. ### snippet.defaultheader The default header that's displayed at the top of all emails. If the [account's **Enable Home Group Branding** setting](https://support.smarteru.com/docs/account-settings#enable-home-group-branding) is not selected, the [account's logo](https://support.smarteru.com/docs/account-customization#logo) displays. If the [account's **Enable Home Group Branding** setting](https://support.smarteru.com/docs/account-settings#enable-home-group-branding) is selected, the [group's logo](https://support.smarteru.com/docs/group-group-information#logo) displays. If the group does not have a logo, the [account's logo](https://support.smarteru.com/docs/account-customization#logo) displays. ### snippet.footerunsubscribemessage The default message for how to unsubscribe from emails. ## Subscription Variables ### subscription.duration The [subscription variant's duration](/v1/docs/variant-duration#duration). ### subscription.enddate The date the learner's subscription ends. ### subscription.startdate The date the learner's subscription begins. ### subscription.subscriptiondescription The [subscription's description](/v1/docs/subscription-main#description). ### subscription.subscriptionname The [subscription's name](/v1/docs/subscription-main#name-required). ### subscription.variantname The [variant's name](/v1/docs/variant-main#name-required). ## User Variables ### user.email The [user's email address](/v1/docs/user-login-information#primary-email-required-if-employee-id-not-specified). ### user.employeeid The [user's employee ID](/v1/docs/user-login-information#employee-id-required-if-primary-email-not-specified). ### user.fullname The user's full name. ### user.givenname The [user's given name](/v1/docs/user-login-information#given-names-required). ### user.homegroup The name of the [user's home group](/v1/docs/home-groups). ### user.homegroupid The [group ID](/v1/docs/group-group-information#group-id) of the [user's home group](/v1/docs/home-groups). ### user.homegrouplogo The [group logo](/v1/docs/group-group-information#logo) of the [user's home group](/v1/docs/home-groups). ### user.surname The [user's surname](/v1/docs/user-login-information#surname-required). ## Video Variables ### video.filename The video's filename. ### video.information The video's filename and location. ## Related - [Adding a Variable to Your Content](/adding-a-variable-to-your-content.md) - [Email Template Snippets](/email-template-snippets.md) - [Email Template Variables](/email-template-variables.md) - [Email Templates](/email-templates.md) - [System Email Templates](/system-email-templates.md)