For the complete documentation index, see llms.txt. This page is also available as Markdown.

Login

Configure how customers sign in to the Customer Portal, how long their sessions remain active, and which additional authentication options are available.

From the Login settings, you can:

  • Select the customer login method.

  • Enable Two-Factor Authentication or Login Link authentication.

  • Configure the login session duration.

  • Display a Remember Me option on the login page.

Open the Login Settings

From the Customer Portal Builder, select Login from the left-side menu.


Login Method

Use Login Method to determine which credentials customers use to access their portal account.

Option
What it does

Username

Customers sign in using their username and password.

Email

Customers sign in using their email address and order ID.

Select the method that matches how customers should access the Customer Portal.


Authentication Type

Use the Authentication Type settings to enable additional authentication options for customers.

Two-Factor Authentication

Turn on Two-Factor Authentication to require customers to verify their identity using a one-time verification code.

A supported delivery method, such as email or SMS, must be configured before this option is enabled.

Two-Factor Authentication Autoresponder Setup

Two-Factor Authentication depends on an autoresponder configured in the CRM. Enabling the setting in the Customer Portal Builder does not create the required autoresponder automatically.

Configure an autoresponder for each verification method that customers can use.

The autoresponder must:

  • Use the supported Customer Portal Two-Factor Authentication event.

  • Be active and associated with the same campaign used by the Customer Portal.

  • Include the verification-code token provided for the selected event.

  • Use a delivery method that is properly configured for the campaign.

For email verification, the customer must have a valid email address. For SMS verification, the customer must have a valid phone number, and SMS delivery must be configured for the campaign.

Do not enter a fixed verification code in the message. The autoresponder must use the verification-code token so that each customer receives a unique code.

Turn on Login Link to allow customers to receive a secure link that signs them in without requiring their standard login credentials.

This option provides a simpler login experience for customers who may not remember their password or order information.

Login Link authentication depends on an email autoresponder configured in the CRM. Enabling the setting in the Customer Portal Builder does not create the required autoresponder automatically.

The autoresponder must:

  • Use the supported Customer Portal Login Link event.

  • Be active and associated with the same campaign used by the Customer Portal.

  • Send to the customer’s email address.

  • Include the generated secure login-link token provided for the selected event.

The template button/link contains an example url. Replace the url with the one matching the page the customer should land on. Do not delete the url parameters. This would include "?" and anything after it in the example.

The generated login link should be used instead of placing the customer’s username, password, or order information directly in the URL.

Example URL applied to link or button:

https://membershipurl.com/portal?access=[customerToken]

Login links expire after 24 hours.

When a Login Link autoresponder directs the customer to a specific portal action, such as subscription cancellation, the action is appended to the generated customerToken. You do not need to manually add the action parameter to the autoresponder URL.

Autoresponder Requirements Summary

Requirement
Login Link
Two-Factor Authentication

Active autoresponder

Required

Required

Associated with the portal campaign

Required

Required

Customer email address

Required

Required for email verification

Customer phone number

Not required

Required for SMS verification

Authentication token included

Login-link token

Verification-code token

Supported delivery method configured

Email

Email or SMS

Send a test autoresponder before publishing the Customer Portal to confirm that the message is delivered and that the login link or verification code works correctly.


Login Lifetime

Use Login Lifetime (Hours) to specify how long a customer’s login session can remain active before they must sign in again.

For example:

A value of 24 allows the customer’s session to remain active for up to 24 hours.

The value must be entered in hours.


Settings

Display Remember Me

Turn on Display Remember Me to show a Remember Me option on the Customer Portal login page.

Use this setting when you want to give customers more control over their login session.


Additional Information

URL Parameters

URL parameters can be used to authenticate a customer automatically or direct them to a specific portal action.

Login Parameters

The required login parameters depend on the selected Login Method.

Email and Order ID

Use emailAddress and orderId when the portal uses the Email login method.

Page URL

CRM Email or SMS Autoresponder

Username and Password

Use username and password when the portal uses the Username login method.

Page URL

CRM Email or SMS Autoresponder


Action Parameter

Use the action parameter to direct the customer to a supported page or action after authentication.

When login credentials are included directly in the URL, the action parameter can only be used with the emailAddress and orderId login parameters.

Action
Description

action=pause

Prompts the user to pause their subscription.

action=card

Directs the customer to the card section on Profile page.

action=cancel

Prompts the user to cancel their subscription.

action=reactivate

Prompts the user to reactivate their subscription.

Page URL

CRM Email or SMS Autoresponder

In this example, the customer is authenticated and then directed to the subscription cancellation experience.

The action behavior is also supported with Two-Factor Authentication and Login Link authentication. When using a Login Link autoresponder, do not manually add the action parameter to the generated login URL. The action is appended to the customerToken on the autoresponder automatically.

Last updated