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:
earnPoints() functions and switch off all the "Earn Points" and "Rewards" toggles in the Loyalty Program dashboard.Note: Only visitors with Manage Loyalty permissions can activate a loyalty program. You can override the permissions with the wix-auth elevate() function.
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Updates the pointsExpiration status to DISABLED.
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Updates the pointsExpiration status to ENABLED.
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Retrieves the site's loyalty program.
The getLoyaltyProgram() function returns a Promise that resolves to the site's loyalty program.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves information about the available loyalty program premium features.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Changes the program status to PAUSED.
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Updates the site's loyalty program.
The updateLoyaltyProgram() function returns a Promise that resolves when the loyalty program is updated.
With the updateLoyaltyProgram() function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the activateLoyaltyProgram() function.
Note: Only visitors with Manage Loyalty permissions can update a loyalty program. You can override the permissions with the wix-auth elevate() function.
You can only call this method when authenticated as a Wix app or Wix user identity.
Loyalty program fields to update.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Triggered when a loyalty program is updated.
handler(event: ProgramUpdatedEnvelope): void | Promise<void>