List of available variables in the Message template

You can use variables in the Message template field to retrieve dynamic data for each user.

Different variables are available depending on the template. The following is a list of variables that can be used in the Message template slug.

Workflow

approvalflow/approve_finish

Sending Timing
Upon completion of the approval workflow.

Recipients
The applicant, the workflow approvers, and the email notification recipients set in the basic workflow settings.

Available Variables

Variable	Description
$apply_member_id	Member ID of requester.
$apply_member_nm	Name of requester.
$apply_date	Request date.
$apply_comment	Note or comment about the request.
$approve_member_id	Member ID of the requester with the latest approved data.
$approve_member_nm	Name of the requester with the latest approved data.
$approve_date	Request date for the latest approved data.
$approve_comment	Note or comment about the latest approved data
$publish_ymdhi	Date and time of approval.
$link	URL link of the request data.
$title	Title of the request data.
$draft_detail	Draft details about the request data.
$site_uri	Site URI.
$module_data	Details about new and rejected modules.

approvalflow/approval_alert

Sending Timing
When the approval_alert batch is executed (runs daily at 7 AM). This is enabled when an alert deadline is set in the basic approval workflow settings.

Recipients
Email notification recipients set in the basic approval workflow settings.

Available Variables

Variable	Description
$row.span	Number of days elapsed since the request was submitted
$row.link	URL to the edit screen
$row.module_type	Module type
$row.target_type	Target type
$row.langName	Request language name
$row.alert_day_span	Alert deadline days
$row.mail_subject	Email subject
$row.mail_body	Email body
$row.mail_addresses	Notification email addresses
$row.module_nm	Module name
$row.module_id	Module ID
$row.apply_language	Request language

approvalflow/approve_reject

Sending Timing
When approval workflow rejection is completed.

Recipients
The applicant, workflow approvers, and email notification recipients set in the basic approval workflow settings.

Available Variables

Variable	Description
$apply_member_id	Member ID of requester
$apply_member_nm	Name of requester
$apply_date	Request date
$comment	Update comment (rejection reason)
$reject_date	Rejection date and time
$reject_member_id	Member ID of the person who executed the rejection
$reject_member_nm	Name of the person who executed the rejection
$draft_id	Draft ID
$draft_details	Draft detail information
$link	URL to the request data
$title	Title of the request data
$module_data	Module data
$module_nm	Module name
$module_id	Module ID
$publish_ymdhi	Date and time of approval reflection

approvalflow/scheduled_publish

Sending Timing
When approved content reaches its scheduled reflection date and time and the approval content is applied.

Recipients
The applicant, final approver of the workflow, and email notification recipients set in the basic approval workflow settings.

Available Variables

Variable	Description
$apply_member_id	Member ID of requester
$apply_member_nm	Name of requester
$apply_date	Request date
$apply_comment	Request comment
$approve_comment	Approval comment from the final approved data
$approve_date	Approval date of the last approval
$approve_member_id	Approver ID of the last approval
$approve_member_nm	Approver name of the last approval
$publish_ymdhi	Date and time of approval reflection
$link	URL to the request data
$title	Title of the request data
$module_data	Module data
$module_nm	Module name
$module_id	Module ID

E-commerce

ec/AlertLimitPayment_Conveni

Message sent N days before the payment deadline if the convenience store (konbini) payment has not been received.

Variable	Description
$order	Information about the order.
$orderDetails	Details of the order.
$products	Products ordered and corresponding product information.

ec/NoticeExpirePremiumMembership

By default, users will receive the paid membership expiration e-mail notification 1 month (30 days) before their membership expires.

Variable	Description
$name1	Registered family name of the user.
$name2	Registered given name of the user.
$email	Registered e-mail address of the user.
$product_content	List of products ordered.
$inquiry_url	URL of the inquiry page.
$from_name	Title of the site.

ec/Membership_Cancel

Users will receive this notification when they cancel their premium membership.

Variable	Description
$name1	Registered family name of the user.
$name2	Registered given name of the user.
$email	Registered e-mail address of the user.
$product_content	List of canceled orders.
$inquiry_url	URL of the inquiry page.
$from_name	Title of the site.

ec/Shipping_guest

Guests (i.e., logged-out users) will receive this e-mail when products are shipped from the sales/delivery management screen.

Variable	Description
$name1	Registered family name of the user.
$name2	Registered given name of the user.
$email	Registered e-mail address of the user.
$product_content	List of products ordered.
$inquiry_url	URL of the inquiry page.
$from_name	Title of the site.

ec/Shipping_member

Members (i.e., logged-in users) will receive this e-mail when products are shipped from the sales/delivery management screen.

Variable	Description
$name1	Registered family name of the user.
$name2	Registered given name of the user.
$email	Registered e-mail address of the user.
$product_content	List of products ordered.
$order_history_url	URL of the user's order history.
$inquiry_url	URL of the inquiry page.
$from_name	Title of the site.

Form

inquiry/inquiry_contact_simple

Conditions
When the email address in the form's basic settings is set to "Notify sending all the information" and a ZIP password has been entered.

Sending Timing
When a response is added to the form at the InquiryMessage::send endpoint.

Recipients
The email address entered in the recipient email address field.

Available Variables

Variable	Description
$inquiryHeader	Header information of the inquiry form.
$inquiryHeader.inquiry_name	Title of the inquiry form.
$inquiry_id	Unique ID of the inquiry form.
$parent_inquiry_bn_id	Unique ID of the parent inquiry.
$inquiry_bn_id	Unique ID of the inquiry.

inquiry/inquiry_contact

Conditions

• When the recipient email address in the form's basic settings is set to "Notify".
• When the recipient email address in the form's basic settings is set to "Notify sending all the information" and a ZIP password has not been entered.

Sending Timing
When a response is added to the form at the InquiryMessage::send endpoint.

Recipients
The email address entered in the recipient email address field.

Available Variables

Variable	Description
$file_flg	File flag. This value is set to 1 if there is an attachment, and 0 otherwise.
$inquiryHeader	Header information of the inquiry form.
$inquiryHeader.inquiry_name	Title of the inquiry form.
$inquiryHeader.contact_flg	The options for the "mail address" field of the inquiry form settings are: don't notify, notify, and notify all. If you specify notify all (INQUIRY_CONTACT_ALL), the form input will be included in the notification e-mail.
$inquiry_id	Unique ID of the inquiry form.
$parent_inquiry_bn_id	Unique IDs of the main inquiry subdivision.
$inquiry_bn_id	Unique ID of the inquiry.
$items	User inquiry information. Displayed as an array with the inquiry items as keys and the responses to the items as values.

Login

login/reset_password

Sending Timing

• When a password reset email is sent on the /management/login/reminder/ page.
• When the Login::reminder endpoint is used.

Recipients
The email address entered (POSTed).

Available Variables

Variable	Description
$url	URL of the password settings screen.
$name	Name of the user.
$login_id	Login ID of the user.
$Email	E-mail address of the user.
$temp_pwd	Temporary password.
$token	Authentication token (configured in the URL parameters).
$name1	Family name of the user (configured in the login/reminder API).
$name2	Given name of the user (configured in the login/reminder API).
$member	Target member information (configured in the login/reminder API).

login/password_changed

Conditions
In [Preferences] -> [Site Management], "Send password change completion notification email" is enabled.

Sending Timing

• When the password is changed using the password reminder feature in the admin panel.
• When the password is changed using the Login::reset_password endpoint.

Recipients
The email address of the member whose password was changed.

Notes
Emails will not be sent if the password is changed from the member edit screen in the admin panel or via the Member::update endpoint.

Available Variables

Variable	Description
$name	Name of the user.
$name1	Family name of the user.
$name2	Given name of the user.
$email	E-mail address of the user.
$member	Member information for the user.

login/authentication_code

Conditions
twofactor_method=email is set in the Login::login_challenge endpoint.

Sending Timing
When authentication via email and password is completed in the Login::login_challenge endpoint.

Recipients
The email address of the logged-in member.

Available Variables

Variable	Description
$name1	Family name of the user.
$name2	Given name of the user.
$nickname	Nickname of the user.
$code	Authentication code (6-digit alphanumeric).
$login_code_duration	Validity period of the authentication code (seconds).
$login_code_expires	Expiration time of the authentication code (Unix timestamp).

login/sms_authentication_code

Conditions

• Integrated with Twilio
• Phone number is registered in member information (Japanese mobile phone numbers only)
• twofactor_method=sms is set in the Login::login_challenge endpoint

Sending Timing
When authentication via email and password is completed in the Login::login_challenge endpoint.

Recipients
The phone number of the logged-in member (SMS delivery).

Available Variables

Variable	Description
$name1	Family name of the user.
$name2	Given name of the user.
$nickname	Nickname of the user.
$code	Authentication code (6-digit alphanumeric).
$login_code_duration	Validity period of the authentication code (seconds).
$login_code_expires	Expiration time of the authentication code (Unix timestamp).

Member

memberregist/invite

Sending Timing
When a member is invited from the admin panel.

Recipients
The inviter.

Available Variables

Variable	Description
$key	Authentication token.
$name1	Family name of the invitee.
$name2	Given name of the invitee.
$message	Message from the invitee.
$register_url	URL of the user registration screen.
$basic_auth_id	Basic authentication username (for applicable sites).
$basic_auth_pwd	Basic authentication password (for applicable sites).

member/pre_regist_thanks

Sending Timing
When a pending member registration is completed via the member/invite endpoint.

Recipients
The pending member's email address.

Available Variables

Variable	Description
$ext_info	Extended information configured in the API.
$email	E-mail address of the temporary member.
$preregist_key	Authentication token (configured in the URL parameters).

member/regist_thanks

info

Different variables are available in this template depending on the registration method.

Registration via the management screen

Conditions
The option "Notify user upon registration" is enabled under [Members] -> [Advanced member settings] -> [E-mail notification].

Timing
When a member is registered from the admin panel.

Recipients
The user whose membership registration has been completed.

Available Variables

Variable	Description
$name	Name of the user.
$name1	Family name of the user.
$name2	Given name of the user.
$email	E-mail address of the user.

Registration via API

Conditions
The send_email_flg parameter is enabled in the Member::insert endpoint.

Timing
When a member is registered via the API.

Recipients
The user whose membership registration has been completed.

Available Variables

Variable	Description
$to_name	Family name of the user.
$name	Name of the user.
$name1	Family name of the user.
$name2	Given name of the user.
$email	E-mail address of the user.
$data	User form data.
$form_data	User form data.
$member_id	Member ID of the user.
$password	User password (hidden).
$site_title	Title of the site.
$site_url	Site URL.
$preregist_key	Temporary registration key.

member/regist_alert

Sending Timing
When the invited member completes their membership registration from the admin panel.

Recipients
The user who sent the invitation.

Available Variables

Variable	Description
$name	Name of the member.
$email	E-mail address of the member.
$friend_nm	Name of the invitation sender.
$site_title	Title of the site.
$site_url	Site URL.

member/complete_delete

Conditions
In [Environment] -> [Site settings], "Membership cancellation completion notification" is enabled.

Sending Timing
When a member is deleted via the Member::delete endpoint.

Recipients
The email address of the deleted member.

Notes
Emails will not be sent if the member is deleted from the member edit screen in the admin panel.

Available Variables

Variable	Description
$to_name	Family name of the member.
$name	Name of the member.
$name1	Family name of the member.
$name2	Given name of the member.
$email	E-mail address of the member.
$site_title	Title of the site.
$site_url	Site URL.

member/update_thanks

Conditions
The option "Notify user upon editing" is enabled under [Members] -> [Advanced member settings] -> [E-mail notification].

Sending Timing

• When a member edit is completed from the admin panel.
• When a member edit is completed via the Member::update or Member::bulk_upsert endpoints.

Recipients
The email address of the edited member.

Available Variables

Variable	Description
$name	Name of the member.
$name1	Family name of the member.
$name2	Given name of the member.
$email	E-mail address of the member.
$password	Login password of the member.
$arrGroup_nm	List of user groups the member belongs to.
$form_data	User form data.
$memberExtensionColumns	Extended information about the member.
$original_data	Member information before the update.
$column_diff	Differences in member information before and after the update.

memberregist/edit_notice

Conditions
The option "Notify specified address upon editing" is enabled under [Members] -> [Advanced member settings] -> [E-mail notification].

Sending Timing

• When a member edit is completed from the admin panel.
• When a member edit is completed via the Member::update or Member::bulk_upsert endpoints.

Recipients
The email address entered in the "Notification Address" field upon editing.

Available Variables

Variable	Description
$name	Name of the member.
$name1	Family name of the member.
$name2	Given name of the member.
$email	E-mail address of the member.
$password	Login password of the member.
$arrGroup_nm	List of user groups the member belongs to.
$form_data	User form data.
$memberExtensionColumns	Extended information about the member.
$original_data	Member information before the update.
$column_diff	Differences in member information before and after the update.

memberregist/regist_notice

Conditions
The option "Notify specified address upon registration" is enabled under [Members] -> [Advanced member settings] -> [E-mail notification].

Sending Timing

• When a member's registration is completed from the admin panel (invitation, editing, CSV upload).
• When a member's registration is completed via the Member::update or Member::bulk_upsert endpoints.

Recipients
The email address entered in the "Notification Address" field upon registration.

Available Variables

Variable	Description
$name	Name of the member.
$name1	Family name of the member.
$name2	Given name of the member.
$email	E-mail address of the member.
$password	Login password of the member.
$arrGroup_nm	List of user groups the member belongs to.
$form_data	User form data.
$memberExtensionColumns	Extended information about the member.

Temporary member

onetime/account

Sending Timing
When a temporary member with an expiration date is added or their password is regenerated in [Member Management] -> [Edit Temporary Member with Expiration].

Recipients
The email address of the temporary member.

Available Variables

Variable	Description
$memberInfo	Member information for the user.
$message	Message from the account issuer.
$memberInfo.login_id	User account ID (login ID).
$memberInfo.login_pwd	User login password.
$memberInfo.expire	Expiration date of the one-time account.