createTier( )

Developer Preview

Creates a tier.

Description

The name for a tier and the amount of required points to qualify for a tier can only exist for a single tier. Attempts to create a tier with a tierDefinition.name or requiredPoints that already exists will return an error.

To create up to 20 tiers at once, use bulkCreateTiers().

Note: You must have a Business VIP Premium plan or a Scale Premium plan to add tiers.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function createTier(tier: Tier): Promise<CreateTierResponse>

createTier Parameters

NAME

TYPE

DESCRIPTION

tier

Tier

Tier to create.

Returns

Return Type:

Promise<

CreateTierResponse

NAME

TYPE

DESCRIPTION

tier

Tier

Created loyalty tier.

Was this helpful?

createTier example

Copy Code

1import { tiers } from 'wix-loyalty.v2';
2  
3 async function createTier(tier) {
4   try {
5     const result = await tiers.createTier(tier);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13