activateLoyaltyProgram( )
Activates a loyalty program.
The activateLoyaltyProgram()
function returns a Promise that resolves when the status of the loyalty program is successfully changed to "ACTIVE"
.
Before you begin, a Wix Loyalty Program must first be installed through your dashboard or through the Wix App Market. Initially when a loyalty program is installed, the status is set to "DRAFT"
. You can change the program's status to "ACTIVE"
with this function or through your dashboard. A site's customers can only earn or redeem points while the program status is "ACTIVE"
.
This function updates only the status of a loyalty program, to make other updates to the program, use the updateLoyaltyProgram()
function.
To temporarily pause your loyalty program you must follow three steps:
- Remove all
earnPoints()
functions and switch off all the "Earn Points" and "Rewards" toggles in the Loyalty Program dashboard. - Hide the loyalty page from your site.
- Delete the My Rewards page from the Member pages. See Pausing Your Loyalty Program for more information.
Note: Only visitors with Manage Loyalty permissions can activate a loyalty program. You can override the permissions with the wix-auth
elevate()
function.
Permission Scopes
For app development, you must have one of the following permission scopes: