Customers configuration paths reference

This section lists variable names and config paths available for options in the Admin under Stores > Settings > Configuration > Customers.

The magento app:config:dump command writes these values to the shared configuration file, app/etc/config.php, which should be in source control. To optionally override any configuration settings or to set sensitive settings, see Use environment variables to override configuration settings. This topic does not list sensitive and system-specific values.

Newsletter paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Customers > Newsletter.

Name
Config path
Commerce only?
Allow Guest Subscription
newsletter/subscription/allow_guest_subscribe
Need to Confirm
newsletter/subscription/confirm
Confirmation Email Sender
newsletter/subscription/confirm_email_identity
Confirmation Email Template
newsletter/subscription/confirm_email_template
Success Email Sender
newsletter/subscription/success_email_identity
Success Email Template
newsletter/subscription/success_email_template
Unsubscription Email Sender
newsletter/subscription/un_email_identity
Unsubscription Email Template
newsletter/subscription/un_email_template

Customer configuration paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Customers > Customer Configuration.

Name
Config path
Commerce only?
Online Minutes Interval
customer/online_customers/online_minutes_interval
Share Customer Accounts
customer/account_share/scope
Enable Automatic Assignment to Customer Group
customer/create_account/auto_group_assign
Tax Calculation Based On
customer/create_account/tax_calculation_address_type
Default Group
customer/create_account/default_group
Group for Valid VAT ID - Domestic
customer/create_account/viv_domestic_group
Group for Valid VAT ID - Intra-Union
customer/create_account/viv_intra_union_group
Group for Invalid VAT ID
customer/create_account/viv_invalid_group
Validation Error Group
customer/create_account/viv_error_group
Validate on Each Transaction
customer/create_account/viv_on_each_transaction
Default Value for Disable Automatic Group Changes Based on VAT ID
customer/create_account/viv_disable_auto_group_assign_default
Show VAT Number on Storefront
customer/create_account/vat_frontend_visibility
Default Welcome Email
customer/create_account/email_template
Default Welcome Email Without Password
customer/create_account/email_no_password_template
Email Sender
customer/create_account/email_identity
Require Emails Confirmation
customer/create_account/confirm
Confirmation Link Email
customer/create_account/email_confirmation_template
Welcome Email
customer/create_account/email_confirmed_template
Generate Human-Friendly Customer ID
customer/create_account/generate_human_friendly_id
Password Reset Protection Type
customer/password/password_reset_protection_type
Max Number of Password Reset Requests
customer/password/max_number_password_reset_requests
Min Time Between Password Reset Requests
customer/password/min_time_between_password_reset_requests
Forgot Email Template
customer/password/forgot_email_template
Remind Email Template
customer/password/remind_email_template
Reset Password Template
customer/password/reset_password_template
Password Template Email Sender
customer/password/forgot_email_identity
Recovery Link Expiration Period (hours)
customer/password/reset_link_expiration_period
Enable Autocomplete on login/forgot password forms
customer/password/autocomplete_on_storefront
Number of Required Character Classes
customer/password/required_character_classes_number
Maximum Login Failures to Lockout Account
customer/password/lockout_failures
Minimum Password Length
customer/password/minimum_password_length
Lockout Time (minutes)
customer/password/lockout_threshold
Number of Lines in a Street Address
customer/address/street_lines
Show Prefix
customer/address/prefix_show
Prefix Dropdown Options
customer/address/prefix_options
Show Middle Name (initial)
customer/address/middlename_show
Show Suffix
customer/address/suffix_show
Suffix Dropdown Options
customer/address/suffix_options
Show Date of Birth
customer/address/dob_show
In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data.
Show Tax/VAT Number
customer/address/taxvat_show
Show Gender
customer/address/gender_show
Enable Store Credit Functionality
customer/magento_customerbalance/is_enabled
Commerce-only
Show Store Credit History to Customers
customer/magento_customerbalance/show_history
Commerce-only
Refund Store Credit Automatically
customer/magento_customerbalance/refund_automatically
Commerce-only
Store Credit Update Email Sender
customer/magento_customerbalance/email_identity
Commerce-only
Store Credit Update Email Template
customer/magento_customerbalance/email_template
Commerce-only
Redirect Customer to Account Dashboard after Logging in
customer/startup/redirect_dashboard
Text
customer/address_templates/text
Text One Line
customer/address_templates/oneline
HTML
customer/address_templates/html
PDF
customer/address_templates/pdf
Enable Customer Segment Functionality
customer/magento_customersegment/is_enabled
Commerce-only
Enable CAPTCHA on Storefront
customer/captcha/enable
Font
customer/captcha/font
Forms
customer/captcha/forms
Displaying Mode
customer/captcha/mode
Number of Unsuccessful Attempts to Login
customer/captcha/failed_attempts_login
CAPTCHA Timeout (minutes)
customer/captcha/timeout
Number of Symbols
customer/captcha/length
Symbols Used in CAPTCHA
customer/captcha/symbols
Case Sensitive
customer/captcha/case_sensitive

Wish list paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Customers > Wish List.

Name
Config path
Commerce only?
Enabled
wishlist/general/active
Enable Multiple Wish Lists
wishlist/general/multiple_enabled
Commerce-only
Number of Multiple Wish Lists
wishlist/general/multiple_wishlist_number
Commerce-only
Email Sender
wishlist/email/email_identity
Email Template
wishlist/email/email_template
Max Emails Allowed to be Sent
wishlist/email/number_limit
Email Text Length Limit
wishlist/email/text_limit
Display Wish Lists Summary
wishlist/wishlist_link/use_qty

Invitations paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Customers > Invitations.

Name
Config path
Commerce only?
Enable Invitations Functionality
magento_invitation/general/enabled
Commerce-only
Enable Invitations on Storefront
magento_invitation/general/enabled_on_front
Commerce-only
Referred Customer Group
magento_invitation/general/registration_use_inviter_group
Commerce-only
New Accounts Registration
magento_invitation/general/registration_required_invitation
Commerce-only
Allow Customers to Add Custom Message to Invitation Email
magento_invitation/general/allow_customer_message
Commerce-only
Max Invitations Allowed to be Sent at One Time
magento_invitation/general/max_invitation_amount_per_send
Commerce-only
Customer Invitation Email Sender
magento_invitation/email/identity
Commerce-only
Customer Invitation Email Template
magento_invitation/email/template
Commerce-only

Reward points paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Customers > Reward Points.

Name
Config path
Commerce only?
Enable Reward Points Functionality
magento_reward/general/is_enabled
Commerce-only
Enable Reward Points Functionality on Storefront
magento_reward/general/is_enabled_on_front
Commerce-only
Customers May See Reward Points History
magento_reward/general/publish_history
Commerce-only
Rewards Points Balance Redemption Threshold
magento_reward/general/min_points_balance
Commerce-only
Cap Reward Points Balance At
magento_reward/general/max_points_balance
Commerce-only
Reward Points Expire in (days)
magento_reward/general/expiration_days
Commerce-only
Reward Points Expiry Calculation
magento_reward/general/expiry_calculation
Commerce-only
Refund Reward Points Automatically
magento_reward/general/refund_automatically
Commerce-only
Deduct Reward Points from Refund Amount Automatically
magento_reward/general/deduct_automatically
Commerce-only
Landing Page
magento_reward/general/landing_page
Commerce-only
Purchase
magento_reward/points/order
Commerce-only
Registration
magento_reward/points/register
Commerce-only
Newsletter Signup
magento_reward/points/newsletter
Commerce-only
Converting Invitation to Customer
magento_reward/points/invitation_customer
Commerce-only
Invitation to Customer Conversions Quantity Limit
magento_reward/points/invitation_customer_limit
Commerce-only
Converting Invitation to Order
magento_reward/points/invitation_order
Commerce-only
Invitation to Order Conversions Quantity Limit
magento_reward/points/invitation_order_limit
Commerce-only
Invitation Conversion to Order Reward
magento_reward/points/invitation_order_frequency
Commerce-only
Review Submission
magento_reward/points/review
Commerce-only
Rewarded Reviews Submission Quantity Limit
magento_reward/points/review_limit
Commerce-only
Email Sender
magento_reward/notification/email_sender
Commerce-only
Subscribe Customers by Default
magento_reward/notification/subscribe_by_default
Commerce-only
Balance Update Email
magento_reward/notification/balance_update_template
Commerce-only
Reward Points Expiry Warning Email
magento_reward/notification/expiry_warning_template
Commerce-only
Expiry Warning Before (days)
magento_reward/notification/expiry_day_before
Commerce-only

Promotions paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Customers > Promotions.

Name
Config path
Commerce only?
Enable Reminder Emails
promo/magento_reminder/enabled
Frequency
promo/magento_reminder/frequency
Interval
promo/magento_reminder/interval
Minute of the Hour
promo/magento_reminder/minutes
Commerce-only
Start Time
promo/magento_reminder/time
Commerce-only
Maximum Emails per One Run
promo/magento_reminder/limit
Commerce-only
Email Send Failure Threshold
promo/magento_reminder/threshold
Commerce-only
Reminder Email Sender
promo/magento_reminder/identity
Commerce-only
Code Length
promo/auto_generated_coupon_codes/length
Code Format
promo/auto_generated_coupon_codes/format
Code Prefix
promo/auto_generated_coupon_codes/prefix
Code Suffix
promo/auto_generated_coupon_codes/suffix
Dash Every X Characters
promo/auto_generated_coupon_codes/dash

Gift registry paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Customers > Gift Registry.

Name
Config path
Commerce only?
Enable Gift Registry
magento_giftregistry/general/enabled
Maximum Registrants
magento_giftregistry/general/max_registrant
Email Template
magento_giftregistry/owner_email/template
Email Sender
magento_giftregistry/owner_email/identity
Email Template
magento_giftregistry/sharing_email/template
Email Sender
magento_giftregistry/sharing_email/identity
Maximum Sent Emails Threshold
magento_giftregistry/sharing_email/send_limit
Email Template
magento_giftregistry/update_email/template
Email Sender
magento_giftregistry/update_email/identity

Persistent shopping cart paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Customers > Persistent Shopping Cart.

Name
Config path
Commerce only?
Enable Persistence
persistent/options/enabled
Persistence Lifetime (seconds)
persistent/options/lifetime
Enable “Remember Me”
persistent/options/remember_enabled
“Remember Me” Default Value
persistent/options/remember_default
Clear Persistence on Sign Out
persistent/options/logout_clear
Persist Shopping Cart
persistent/options/shopping_cart
Persist Wish List
persistent/options/wishlist
Persist Recently Ordered Items
persistent/options/recently_ordered
Persist Currently Compared Products
persistent/options/compare_current
Persist Comparison History
persistent/options/compare_history
Persist Recently Viewed Products
persistent/options/recently_viewed
Persist Customer Group Membership and Segmentation
persistent/options/customer
recommendation-more-help
386822bd-e32c-40a8-81c2-ed90ad1e198c