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:

  1. Remove all earnPoints() functions and switch off all the "Earn Points" and "Rewards" toggles in the Loyalty Program dashboard.
  2. Hide the loyalty page from your site.
  3. 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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Loyalty
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<ActivateLoyaltyProgramResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

disablePointsExpiration( )

Updates the pointsExpiration status to DISABLED.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Loyalty
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<DisablePointsExpirationResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

enablePointsExpiration( )

Updates the pointsExpiration status to ENABLED.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Loyalty
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<EnablePointsExpirationResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

getLoyaltyProgram( )

Retrieves the site's loyalty program.

The getLoyaltyProgram() function returns a Promise that resolves to the site's loyalty program.

Permissions
Manage Loyalty
Read Loyalty
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<GetLoyaltyProgramResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

getLoyaltyProgramPremiumFeatures( )

Developer Preview

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.

Permissions
Manage Loyalty
Read Loyalty
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<GetLoyaltyProgramPremiumFeaturesResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

pauseLoyaltyProgram( )

Changes the program status to PAUSED.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Loyalty
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<PauseLoyaltyProgramResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

updateLoyaltyProgram( )

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Loyalty
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
loyaltyProgramLoyaltyProgramRequired

Loyalty program fields to update.

Returns
Return Type:Promise<UpdateLoyaltyProgramResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

onProgramUpdated( )

Note: This method registers a callback function as an event handler. Subscribe your app to the relevant event via the Webhooks page in the Wix Dev Center to enable it. For more information, see Handle Events With Webhooks.

Triggered when a loyalty program is updated.

Permissions
Manage Loyalty
Read Loyalty
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
handlerfunction

handler(event: ProgramUpdatedEnvelope): void | Promise<void>

Did this help?