Get points constraints

This API allows the brand to retrieve the details of the points restrictions set for the customer.

๐Ÿ‘

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 MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

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

Response 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_REDEMPTION_TYPE, CUSTOMER.

Only one combination of Constraint_Level & KPI is allowed with the DAILY, WEEKLY, or MONTHLY frequency type.
frequencyTypeStringThe frequency at which the constraint is applied. Supported values: DAILY, WEEKLY, MONTHLY.
constraintLimitValueIntegerThe limit value for the constraint
isActiveBooleanStatus indicating whether the constraint is active
intervalValueIntegerThe interval at which the frequency is applied (daily)
status.successBooleanIndicates if the status check was successful
status.codeIntegerStatus code associated with the constraint check
redemptionTypeStringType of redemption managed by this constraint
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!