API Documentation

Manual Tier Adjustment

post
https://{host}/v2/slab/manualSlabAdjustment
Query Params
string
required

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

string
required

Value corresponding to the identifierName provided.

string

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

Body Params
int32
required

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

string
enum
required

UPGRADE, DOWNGRADE, RENEWAL, EXTEND_CURRENT_TIER_EXPIRY_DATE

Allowed:
string

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

string
enum
required

Validity period for the tier change.

Allowed:
int64
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.

boolean
Defaults to false

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

string

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
URL
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
Updated about 1 month ago