Go Headless

Build Apps

Client

API Preview

Ricos

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';

async function activateLoyaltyProgram() {
  const response = await programs.activateLoyaltyProgram();
};

activateLoyaltyProgram: Wix-hosted

import { createClient } from '@wix/sdk';
import { programs } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { programs },
  // Include the auth strategy and host as relevant
});


async function activateLoyaltyProgram() {
  const response = await myWixClient.programs.activateLoyaltyProgram();
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

activateLoyaltyProgram: Self-hosted

activateLoyaltyProgram

Manage Loyalty

ActivateLoyaltyProgramResponse

Updates the `pointsExpiration` status to `DISABLED`.

import { programs } from '@wix/loyalty';

async function disablePointsExpiration() {
  const response = await programs.disablePointsExpiration();
};

disablePointsExpiration: Wix-hosted

import { createClient } from '@wix/sdk';
import { programs } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { programs },
  // Include the auth strategy and host as relevant
});


async function disablePointsExpiration() {
  const response = await myWixClient.programs.disablePointsExpiration();
};

disablePointsExpiration: Self-hosted

disablePointsExpiration

DisablePointsExpirationResponse

Updates the `pointsExpiration` status to `ENABLED`.

import { programs } from '@wix/loyalty';

async function enablePointsExpiration() {
  const response = await programs.enablePointsExpiration();
};

enablePointsExpiration: Wix-hosted

import { createClient } from '@wix/sdk';
import { programs } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { programs },
  // Include the auth strategy and host as relevant
});


async function enablePointsExpiration() {
  const response = await myWixClient.programs.enablePointsExpiration();
};

enablePointsExpiration: Self-hosted

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';

async function getLoyaltyProgram() {
  const response = await programs.getLoyaltyProgram();
};

getLoyaltyProgram: Wix-hosted

import { createClient } from '@wix/sdk';
import { programs } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { programs },
  // Include the auth strategy and host as relevant
});


async function getLoyaltyProgram() {
  const response = await myWixClient.programs.getLoyaltyProgram();
};

getLoyaltyProgram: Self-hosted

getLoyaltyProgram

Read Loyalty

GetLoyaltyProgramResponse

Retrieves information about the available loyalty program premium features.

import { programs } from '@wix/loyalty';

async function getLoyaltyProgramPremiumFeatures() {
  const response = await programs.getLoyaltyProgramPremiumFeatures();
};

getLoyaltyProgramPremiumFeatures: Wix-hosted

import { createClient } from '@wix/sdk';
import { programs } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { programs },
  // Include the auth strategy and host as relevant
});


async function getLoyaltyProgramPremiumFeatures() {
  const response = await myWixClient.programs.getLoyaltyProgramPremiumFeatures();
};

getLoyaltyProgramPremiumFeatures: Self-hosted

getLoyaltyProgramPremiumFeatures

GetLoyaltyProgramPremiumFeaturesResponse

import { programs } from '@wix/loyalty';

async function pauseLoyaltyProgram() {
  const response = await programs.pauseLoyaltyProgram();
};

pauseLoyaltyProgram: Wix-hosted

import { createClient } from '@wix/sdk';
import { programs } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { programs },
  // Include the auth strategy and host as relevant
});


async function pauseLoyaltyProgram() {
  const response = await myWixClient.programs.pauseLoyaltyProgram();
};

pauseLoyaltyProgram: Self-hosted

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';

async function updateLoyaltyProgram(loyaltyProgram) {
  const response = await programs.updateLoyaltyProgram(loyaltyProgram);
};

updateLoyaltyProgram: Wix-hosted

import { createClient } from '@wix/sdk';
import { programs } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { programs },
  // Include the auth strategy and host as relevant
});


async function updateLoyaltyProgram(loyaltyProgram) {
  const response = await myWixClient.programs.updateLoyaltyProgram(loyaltyProgram);
};

updateLoyaltyProgram: Self-hosted

updateLoyaltyProgram

UpdateLoyaltyProgramResponse

# About Loyalty Program

The Loyalty Program API allows a site owner to activate their site's loyalty program and manage its details, like the point name and point icon. The loyalty program must be `ACTIVE` to start creating customer loyalty accounts and tracking their point balances.

With the Loyalty Program API, you can:

- [Activate](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) a loyalty program.
- [Update](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) the name and icon for the program's points.
- [Retrieve](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/get-loyalty-program) a loyalty program.

> **Note:**
> In order to use the Loyalty Program API, the Wix site owner must first install the Wix Loyalty Program app to their site. A site owner can install the app through their [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).

@package_metadata:@wix/loyalty

To use the Programs API, install the `@wix/loyalty` package using npm or Yarn:
  ```console
npm install @wix/loyalty
```

or

```console
yarn add @wix/loyalty
```

Then import `{ programs }` from `@wix/loyalty`:

```js
import { programs } from '@wix/loyalty'
```
  

loyalty_programs

BulkGetLoyaltyProgramResponse

programInSites

Loyalty program with disabled points expiration feature.

Loyalty program with enabled points expiration feature.

EventMetadata

Unique event ID.
Allows clients to ignore duplicate webhooks.

string

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z

eventTime

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

boolean

Whether there are any loyalty program premium features.

Whether there is a points expiration premium feature.

pointsExpiration

Whether there is a tiers premium feature.

tiers

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

_createdDate

_updatedDate

name

Information about the program's collectible entity.

pointDefinition

PointDefinition

Configuration for the points expiration feature.

PointsExpiration

Information about the available program premium features.

premiumFeatures

PremiumFeatures

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

Default: `"DRAFT"`

status

ProgramStatus

OnProgramUpdatedHandler

event

ProgramUpdatedEnvelope

void

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`.

customName

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

icon

Percentage of points that a member loses after being inactive.

expiringPointsPercentage

number

How many months a member should be inactive to lose the collected points.

monthsOfInactivity

Status

ProgramInSite

metaSiteId

Program was created but is not enabled yet.

Program was manually disabled by the user. This action can be reverted, meaning the user can set it to be active again.

entity

metadata

Unknown points expiration status. This value is not used.

handler

Triggered when a loyalty program is updated.

import { programs } from '@wix/loyalty';

programs.onProgramUpdated((event) => {
    // handle your event here
});

onProgramUpdated: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      programs,
    },
});

wixClient.programs.onProgramUpdated((event) => {
    // handle your event here
});

getLoyaltyProgramPremiumFeatures( )