activateLoyaltyProgram( )

Activates a loyalty program.

Initially, when a loyalty program is installed, the status is set to "DRAFT". You can change the program's status to "ACTIVE" with this method or through the dashboard. A site's customers can only earn or redeem points while the program is "ACTIVE".

This method only updates the status of a loyalty program. To make other updates to the program, call Update Loyalty Program.

To temporarily pause your loyalty program, call Pause Loyalty Program and see Pausing Your Loyalty Program for more information.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Loyalty
Manage Restaurants - all permissions
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?