Update points restriction

The API allows you to update the points restriction the brands can apply to the customer to the number of points they burn/redeem in the rewards catalog.

๐Ÿ‘

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URIapi_gateway/rewards/core/v1/brand/constraints
HTTP MethodPUT
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/brand/constraints

Request body parameters

ParameterData TypeDescription
rewardConstraintId*IntegerThe rewardConstraintId is generated on creating the points restriction. This is mandatory to update the points restriction.
kpi*StringThe KPI on which the restriction is applied. Supported value: QUANTITY, TRANSACTION_COUNT, POINTS
constraintLevel*EnumThe level at which restrictions would be defined by org and applied.
Supported values: CUSTOMER_SEGMENT, CUSTOMER_TIER, CUSTOMER_LOYALTY_PROGRAM, CUSTOMER_REDEMPTION_TYPE, CUSTOMER_SUPPL_PROGRAM, REWARD, CUSTOMER_LABEL, CUSTOMER, TRANSACTION

Only one combination of Constraint_Level & KPI is allowed with the DAILY, WEEKLY, or MONTHLY frequency type.
frequencyType*EnumThe frequency at which the constraint is applied. Supported values: DAILY, WEEKLY, MONTHLY. By default the
intervalValue*IntegerThe interval at which the frequency is applied.
constraintLimitValue*IntegerThe limit value for the constraint.
isActive*BooleanStatus of the constraint, whether it is active or not
redemptionType*StringType of intouch reward.
Supported values: INTOUCH_REWARD, VENDOR_INTOUCH_REWARD, VENDOR_ONLY_REWARD, CART_PROMOTION, MILES, VOUCHER, POINTS, CHARITY, CASH_BACK,CASH_WALLET,CARD_DISC, GAMES.
[
    {   "kpi" :"POINTS",
        "constraintLevel" : "CUSTOMER_CONTENT_TYPE",
        "frequencyType" : "DAILY",
        "intervalValue" : 1,
        "constraintLimitValue" : 15,
        "isActive" : true,
        "redemptionType": "POINTS"
    }
]

Resopnse parameters


ParameterData TypeDescription
rewardConstraintIdIntegerUnique identifier for the reward constraint
orgIdIntegerIdentifier for the organization
kpiStringThe KPI on which the restriction is applied. Supported value: POINTS
constraintLevelStringThe level at which restrictions would be defined by org and applied on.
Supported values: CUSTOMER_CONTENT_TYPE, CUSTOMER.

Only one combination of Constraint_Level & KPI is allowed with the DAILY, WEEKLY, or MONTHLY frequency type.
frequencyTypeStringFrequency at which the constraint is applied, "DAILY"
constraintLimitValueIntegerThe limit value for the constraint, set at 15
isActiveBooleanStatus indicating whether the constraint is active
intervalValueIntegerThe interval at which the frequency is applied, here it is daily (1)
status.successBooleanIndicates if the status check was successful
status.codeIntegerStatus code associated with the constraint check
redemptionTypeStringType of redemption managed by this constraint, "POINTS"
[
    {
        "rewardConstraintId": 6759,
        "orgId": 50672,
        "kpi": "POINTS",
        "constraintLevel": "CUSTOMER",
        "frequencyType": "DAILY",
        "constraintLimitValue": 8,
        "isActive": false,
        "intervalValue": 3,
        "status": {
            "success": true,
            "code": 0
        }
    }
]

API-specific errors

Error codeDescription
12014Constraint already exist.
12015Constraint does not exist with the passed constraintId, create a new constraint.
12016Cannot pass rewardConstraintId in the create new constraint API.
12017Pass the rewardConstraintId in the update points constraint AP.
12019The limit of org level constraint is reached. Please disable existing constraints to add new constraints. Max org constraints: 50
12020The limit of org level KPIs is reached. Please disable existing KPI constraints to add new constraints. Max org constraints: 15
12022Multiple restrictions are passed. Only one combination of constraint level and KPI is allowed.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!