LoyaltyTier

Create a tier group

Creates a new tier group in a loyalty program. (The changes will take effect with the next publication of the loyalty program)

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID

Request

Tier group creation payload
namestringRequired
Name of the tier group
downgradeStrategyenumOptionalDefaults to real_time

Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary.

Allowed values:
tierOrderlist of stringsOptional
Order of the tiers in the group in ascending order
upgradeStrategyenumOptionalDefaults to real_time

Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary.

Allowed values:

Response

Tier group Successfully created
createdAtdatetime or null
Timestamp when the tier group was created
downgradeStrategyenum or nullDefaults to real_time

Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary.

Allowed values:
idstring or nullformat: "uuid"
Tier group unique identifier
loyaltyProgramIdstring or nullformat: "uuid"
Associated loyalty program Id
namestring or null
Tier group name
tierOrderlist of strings or null
Order of the tiers in the group in ascending order
updatedAtdatetime or null
Timestamp when the tier group was last updated
upgradeStrategyenum or nullDefaults to real_time

Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary.

Allowed values:

Errors