get https://{host}/api_gateway/rewards/core/v1/brand/constraints
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
- Basic or OAuth Authentication
- Default access group
Resource information
| URI | api_gateway/rewards/core/v1/brand/constraints |
| HTTP Method | PUT |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/brand/constraints
Request body parameters
| Parameter | Data Type | Description |
|---|---|---|
| rewardConstraintId* | Integer | The rewardConstraintId is generated on creating the points restriction. This is mandatory to update the points restriction. |
| kpi* | String | The KPI on which the restriction is applied. Supported value: POINTS |
| constraintLevel* | Enum | The 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. |
| frequencyType* | Enum | The frequency at which the constraint is applied. Supported values: DAILY, WEEKLY, MONTHLY. By default the |
| intervalValue* | Integer | The interval at which the frequency is applied. |
| constraintLimitValue* | Integer | The limit value for the constraint. |
| isActive* | Boolean | Status of the constraint, whether it is active or not |
| redemptionType* | String | Type of intouch reward. Supported values: FREE_VOUCHER, VOUCHER/PHYSICAL, VOUCHER/POINTS,CHARITY, MILES, CASH, CASHBACK, CARD LINKED OFFER, GAMES |
[
{ "kpi" :"POINTS",
"constraintLevel" : "CUSTOMER_CONTENT_TYPE",
"frequencyType" : "DAILY",
"intervalValue" : 1,
"constraintLimitValue" : 15,
"isActive" : true,
"redemptionType": "POINTS"
}
]
Resopnse parameters
| Parameter | Data Type | Description |
|---|---|---|
| rewardConstraintId | Integer | Unique identifier for the reward constraint |
| orgId | Integer | Identifier for the organization |
| kpi | String | The KPI on which the restriction is applied. Supported value: POINTS |
| constraintLevel | String | The 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. |
| frequencyType | String | Frequency at which the constraint is applied, "DAILY" |
| constraintLimitValue | Integer | The limit value for the constraint, set at 15 |
| isActive | Boolean | Status indicating whether the constraint is active |
| intervalValue | Integer | The interval at which the frequency is applied, here it is daily (1) |
| status.success | Boolean | Indicates if the status check was successful |
| status.code | Integer | Status code associated with the constraint check |
| redemptionType | String | Type 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 code | Description |
|---|---|
| 12014 | Constraint already exist. |
| 12015 | Constraint does not exist with the passed constraintId, create a new constraint. |
| 12016 | Cannot pass rewardConstraintId in the create new constraint API. |
| 12017 | Pass the rewardConstraintId in the update points constraint AP. |
| 12019 | The limit of org level constraint is reached. Please disable existing constraints to add new constraints. Max org constraints: 50 |
| 12020 | The limit of org level KPIs is reached. Please disable existing KPI constraints to add new constraints. Max org constraints: 15 |
| 12022 | Multiple restrictions are passed. Only one combination of constraint level and KPI is allowed. |