Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

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](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). 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](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). 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()`](wix-loyalty-v2/programs/updateloyaltyprogram) function.

To temporarily pause your loyalty program you must follow three steps:
1. Remove all [`earnPoints()`](wix-loyalty-v2/accounts/earnpoints) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
1. Hide the loyalty page from your site.
1. Delete the My Rewards page from the Member pages.
See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.

>**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can activate a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.

import { programs } from 'wix-loyalty.v2';

export async function myActivateLoyaltyProgramFunction() {

  const elevatedActivateProgram = wixAuth.elevate(programs.activateLoyaltyProgram)

  try {
    const myLoyaltyProgram = await elevatedActivateProgram();

    const name = myLoyaltyProgram.loyaltyProgram.name;
    const status = myLoyaltyProgram.loyaltyProgram.status;

    console.log('Success! The status of your loyalty program is:', status);

    return myLoyaltyProgram;
  } catch (error) {
    console.error(error);
  }
}

/* Promise resolves to:
 * {
 *   "loyaltyProgram": {
 *     "name": "Star Loyalty Program",
 *     "pointDefinition":   {
 *       "customName": "Stars",
 *       "icon": "shapes/39dce0a5d1ce498f95526b1390eaf585.svg",
 *     },
 *     "status": "ACTIVE",
 *     "_createdDate": "2022-05-22T08:18:32.186Z",
 *     "_updatedDate": "2022-05-25T10:36:32.430Z"
 *   }
 * }
 */


Activate loyalty program (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { programs } from 'wix-loyalty.v2';
import { elevate } from 'wix-auth';

export const myActivateLoyaltyProgramFunction = webMethod(Permissions.Anyone, async () => {

  const elevatedActivateProgram = elevate(programs.activateLoyaltyProgram)

  try {
    const myLoyaltyProgram = await elevatedActivateProgram();

    const name = myLoyaltyProgram.loyaltyProgram.name;
    const status = myLoyaltyProgram.loyaltyProgram.status;

    console.log('Success! The status of your loyalty program is:', status);

    return myLoyaltyProgram;
  } catch (error) {
    console.error(error);
  }
});

/* Promise resolves to:
 * {
 *   "loyaltyProgram": {
 *     "name": "Star Loyalty Program",
 *     "pointDefinition":   {
 *       "customName": "Stars",
 *       "icon": "shapes/39dce0a5d1ce498f95526b1390eaf585.svg",
 *     },
 *     "status": "ACTIVE",
 *     "_createdDate": "2022-05-22T08:18:32.186Z",
 *     "_updatedDate": "2022-05-25T10:36:32.430Z"
 *   }
 * }
 */


Activate loyalty program (export from backend code)

activateLoyaltyProgram

ActivateLoyaltyProgramResponse

Updates the `pointsExpiration` status to `DISABLED`.

import { programs } from 'wix-loyalty.v2';

async function disablePointsExpiration() {
  try {
    const result = await programs.disablePointsExpiration();
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


disablePointsExpiration example for dashboard page code

import { programs } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedDisablePointsExpiration = elevate(programs.disablePointsExpiration);

export const disablePointsExpiration = webMethod(
  Permissions.Anyone,
  async () => {
    try {
      const result = await elevatedDisablePointsExpiration();
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


disablePointsExpiration example for exporting from backend code

disablePointsExpiration

DisablePointsExpirationResponse

Updates the `pointsExpiration` status to `ENABLED`.

import { programs } from 'wix-loyalty.v2';

async function enablePointsExpiration() {
  try {
    const result = await programs.enablePointsExpiration();
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


enablePointsExpiration example for dashboard page code

import { programs } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedEnablePointsExpiration = elevate(programs.enablePointsExpiration);

export const enablePointsExpiration = webMethod(
  Permissions.Anyone,
  async () => {
    try {
      const result = await elevatedEnablePointsExpiration();
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


enablePointsExpiration example for exporting from backend code

enablePointsExpiration

EnablePointsExpirationResponse

Retrieves the site's loyalty program.

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

import { programs } from 'wix-loyalty.v2';

export async function myGetLoyaltyProgramFunction() {
  try {
    const myLoyaltyProgram = await programs.getLoyaltyProgram();

    const name = myLoyaltyProgram.loyaltyProgram.name;
    const status = myLoyaltyProgram.loyaltyProgram.status;

    console.log('Success! The status of your loyalty program is:', status);
    return myLoyaltyProgram;
  } catch (error) {
    console.error(error);
  }
}

/* Promise resolves to:
 * {  
 *   "loyaltyProgram": {
 *     "name": "Frequent Flower Program",
 *     "pointDefinition": {
 *       "customName": "Petals",
 *       "icon": "shapes/8de38e8fe76f4e9f937ae23e9ba1eb04.svg"
 *     },
 *     "status": "ACTIVE",
 *     "_createdDate": "2022-11-07T15:26:12.798Z",
 *     "_updatedDate": "2022-11-09T10:00:42.018Z"
 *   }
 * }
 */


Get loyalty program

import { Permissions, webMethod } from 'wix-web-module';
import { programs } from 'wix-loyalty.v2';

export const myGetLoyaltyProgramFunction = webMethod(Permissions.Anyone, async () => {
  try {
    const myLoyaltyProgram = await programs.getLoyaltyProgram();

    const name = myLoyaltyProgram.loyaltyProgram.name;
    const status = myLoyaltyProgram.loyaltyProgram.status;

    console.log('Success! The status of your loyalty program is:', status);
    return myLoyaltyProgram;
  } catch (error) {
    console.error(error);
  }
});

/* Promise resolves to:
 * {  
 *   "loyaltyProgram": {
 *     "name": "Frequent Flower Program",
 *     "pointDefinition": {
 *       "customName": "Petals",
 *       "icon": "shapes/8de38e8fe76f4e9f937ae23e9ba1eb04.svg"
 *     },
 *     "status": "ACTIVE",
 *     "_createdDate": "2022-11-07T15:26:12.798Z",
 *     "_updatedDate": "2022-11-09T10:00:42.018Z"
 *   }
 * }
 */


Get loyalty program (export from backend code)

getLoyaltyProgram

GetLoyaltyProgramResponse

import { programs } from 'wix-loyalty.v2';

async function pauseLoyaltyProgram() {
  try {
    const result = await programs.pauseLoyaltyProgram();
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


pauseLoyaltyProgram example for dashboard page code

import { programs } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedPauseLoyaltyProgram = elevate(programs.pauseLoyaltyProgram);

export const pauseLoyaltyProgram = webMethod(
  Permissions.Anyone,
  async () => {
    try {
      const result = await elevatedPauseLoyaltyProgram();
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


pauseLoyaltyProgram example for exporting from backend code

pauseLoyaltyProgram

PauseLoyaltyProgramResponse

loyaltyProgram

LoyaltyProgram

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()`](wix-loyalty-v2/programs/activateloyaltyprogram) function.

>**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.

import { programs } from 'wix-loyalty.v2';

/* Sample loyaltyProgram object:
 * {
 *   name: 'Flower Power Program',
 *   pointDefinition: {
 *     customName: 'Petals'
 *   }
 * }
 */

export async function myUpdateLoyaltyProgramFunction(loyaltyProgram) {

  const elevatedUpdateProgram = wixAuth.elevate(programs.updatedLoyaltyProgram)

  try {
    const updatedLoyaltyProgram = await elevatedUpdateProgram(loyaltyProgram);

    const newName = updatedLoyaltyProgram.loyaltyProgram.name;
    const newPointsName = updatedLoyaltyProgram.loyaltyProgram.pointDefinition.customName;

    console.log('Success! The names of your loyalty program and its points are now: ', newName, newPointsName);

    return updatedLoyaltyProgram;
  } catch (error) {
  console.error(error);
  }
}

/* Promise resolves to:
 * {
 *    "loyaltyProgram": {
 *      "name": "Flower Power Program",
 *      "pointDefinition": {
 *        "customName": "Petals",
 *        "icon": "shapes/8de38e8fe76f4e9f937ae23e9ba1eb04.svg"
 *      },
 *      "status": "ACTIVE",
 *      "_createdDate": "2022-11-07T15:26:12.798Z",
 *      "_updatedDate": "2022-11-09T10:07:08.601Z"
 *    }
 * }
 */


Update the loyalty program name and the name of its points (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { programs } from 'wix-loyalty.v2';
import { elevate } from 'wix-auth';

/* Sample loyaltyProgram object:
 * {
 *   name: 'Flower Power Program',
 *   pointDefinition: {
 *     customName: 'Petals'
 *   }
 * }
 */

export const myUpdateLoyaltyProgramFunction = webMethod(Permissions.Anyone, async (loyaltyProgram) => {

  const elevatedUpdateProgram = elevate(programs.updatedLoyaltyProgram)

  try {
    const updatedLoyaltyProgram = await elevatedUpdateProgram(loyaltyProgram);

    const newName = updatedLoyaltyProgram.loyaltyProgram.name;
    const newPointsName = updatedLoyaltyProgram.loyaltyProgram.pointDefinition.customName;

    console.log('Success! The names of your loyalty program and its points are now: ', newName, newPointsName);

    return updatedLoyaltyProgram;
  } catch (error) {
  console.error(error);
  }
});

/* Promise resolves to:
 * {
 *    "loyaltyProgram": {
 *      "name": "Flower Power Program",
 *      "pointDefinition": {
 *        "customName": "Petals",
 *        "icon": "shapes/8de38e8fe76f4e9f937ae23e9ba1eb04.svg"
 *      },
 *      "status": "ACTIVE",
 *      "_createdDate": "2022-11-07T15:26:12.798Z",
 *      "_updatedDate": "2022-11-09T10:07:08.601Z"
 *    }
 * }
 */


Update the loyalty program name and the name of its points (export from backend code)

updateLoyaltyProgram

UpdateLoyaltyProgramResponse

---
title: Introduction
---

# Introduction
&nbsp;
<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>  

&nbsp;

The Loyalty Programs API allows you to activate and customize your loyalty program.

With the Loyalty Programs API, you can:
- [Activate](wix-loyalty-v2/programs/activateloyaltyprogram) your loyalty program.
- [Customize](wix-loyalty-v2/programs/updateloyaltyprogram) the name of the program, as well as the name and icon of the loyalty points unit.

To use the Loyalty Programs API, import `{ programs }` from the `wix-loyalty.v2` module. 

```javascript
import { programs } from 'wix-loyalty.v2';
```

## Before you begin

It’s important to note the following points before starting to code:
- A Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or the [Wix App Market](https://www.wix.com/app-market/loyalty) before the Loyalty APIs can be used. 
- A loyalty program only works with certain apps, such as Wix Bookings, Wix Events, Wix Pricing Plans, Wix Restaurants, or Wix Stores. One of those must be installed on your site before the loyalty program can be used.

## Terminology

- **Program name:** Customizable name of the loyalty program.
- **Point:** The collectible unit of the program. Use `pointDefinition` to customize the name and icon of these loyalty points. The default name `”Points”` translates and adjusts to singular based on context. Since a customized name doesn’t adjust based on context it is recommended to use the plural, for example `”Stars”`.

velo-deps_wix-loyalty.v2_programs

BulkGetLoyaltyProgramOptions

metaSiteIds

BulkGetLoyaltyProgramResponse

programInSites

Loyalty program with disabled points expiration feature.

Loyalty program with enabled points expiration feature.

GetLoyaltyProgramDescriptionOptions

List of description fields to retrieve. Supported values: `description`, `updatedDate`.

fields

GetLoyaltyProgramDescriptionResponse

Date and time of the latest description update.

_updatedDate

description

string

GetLoyaltyProgramPremiumFeaturesResponse

Set to true if user has loyalty program premium feature

boolean

Set to true if user has points expiration premium feature

pointsExpiration

Set to true if user has tiers premium feature

tiers

_createdDate

name

Information about the program's collectible entity.

pointDefinition

PointDefinition

PointsExpiration

Information about available premium features

premiumFeatures

PremiumFeatures

Program status. Customers can only earn or redeem points while the program is `ACTIVE`.

Default: `"DRAFT"`

status

ProgramStatus

Display name for the program's collectible unit.

It's recommended to use a plural, for example `Stars`.

In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.

Default: `Points`.

Max: `20` characters.

customName

Image URL. See [Image]($w/image/introduction) for more information on URL formats for images.

getLoyaltyProgram( )

Permission Scopes