Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Manual Tier Adjustment

post/slab/manualSlabAdjustment

Query parameters

identifierNamestring required

Identifier type to identify the customer. Supported values: mobile, id, externalId

identifierValuestring required

Value corresponding to the identifierName provided.

typestring

Type of entity to adjust the tier. Supported values: CUSTOMER

Request body

programIdinteger required

Unique ID of the loyalty program. To retrieve the programId , use the Get Loyalty Programs API.

slabAction'Type of slab change being performed' required

UPGRADE, DOWNGRADE, RENEWAL, EXTEND_CURRENT_TIER_EXPIRY_DATE

toSlabNamestring

Name of the slab to upgrade or downgrade the customer to. This parameter is required if slabAction = UPGRADE or DOWNGRADE. For example, to downgrade a customer from "Gold" to "Silver”, provide the value as "Silver".

manualSlabActionValidity'FIXED_DURATION' | 'SPECIFIC_DATE' | 'CURRENT_TIER_EXPIRY_DATE' | 'AS_PER_TIER_STRATEGY' required

Validity period for the tier change.

manualSlabActionValidityUptointeger required

Date or number of days the customer's tier upgrade or downgrade is valid till. If manualSlabActionValidity = FIXED_DURATION: Provide a numerical value. For example to extend the expiry by 15 days, provide this value as 15. If manualSlabActionValidity = SPECIFIC_DATE: Provide the date till when the tier is valid in YYYY-MM-DD format. For example to extend the expiry till 20th April, 2025, provide this value as 2025-04-20.

reassessTierOnNextActivityboolean

Specify if the customer's tier during their next transaction or activity should be re-evaluated.

slabChangeReasonstring

Reason for changing, renewing or extending the customer's tier. Character limit: 255 characters.

Response

200

OR
OR

Example response

{
  "programId": 2834,
  "entityId": 424134447,
  "sideEffects": [
    {
      "entityType": "USER",
      "previousSlabName": "Silver",
      "previousSlabNumber": 2,
      "upgradedSlabName": "GOLD",
      "upgradedSlabNumber": 3,
      "slabExpiryDate": "30th Nov, 2025",
      "type": "slab"
    }
  ]
}