Update Redemption Rule Status

Update Issuance Rule Status

Description¶

The updateRedemptionRuleStatus endpoint is used to modify the activation status of an existing Redemption rule in the Loyalty Rewards Program. This endpoint supports transitioning a rule from ACTIVEto DISABLED and vice versa.

Request¶

Endpoint¶
/ui/v1/updateRedemptionRuleStatus
Method¶
POST
Header¶

Content-Type: application/json
Authorization: $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: dXNlcm5hbWU6cGFzc3dvcmQ=

Request Body¶

{
    "id": 4,
    "createdDateTime": 1550083652000,
    "lastUpdatedDateTime": 1560958057000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 1,
    "lastModifiedUserId": "642",
    "numberOfPoints": 1,
    "amountIssued": {
        "amount": 0.01,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1733858673000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "minimumRedeemablePoints": 500,
    "maximumRedeemablePointsPerTxn": null,
    "maximumRedeemablePointsPerDay": null,
    "redemptionCategory": {
        "value": "Donate To Charity",
        "name": "DONATE_TO_CHARITY"
    },
    "redemptionRuleStatus": {
        "value": "Disabled",
        "name": "ACTIVE"
    },
    "description": "The charity you choose would get 1 cent per point for the maximum points of 500,000 you donate in a calendar year.",
    "offsetRedeemablePoints": null,
    "loyaltyTierLevel": {
        "nickname": "None",
        "name": "NONE"
    },
    "merchantId": 1,
    "createdUserName": null,
    "message": null
}

Response¶

{
    "id": 4,
    "createdDateTime": 1550083652000,
    "lastUpdatedDateTime": 1560958057000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 1,
    "lastModifiedUserId": 642,
    "numberOfPoints": 1,
    "amountIssued": {
        "amount": 0.010,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1733858673000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "minimumRedeemablePoints": 500,
    "maximumRedeemablePointsPerTxn": null,
    "maximumRedeemablePointsPerDay": null,
    "redemptionCategory": {
        "value": "Donate To Charity",
        "name": "DONATE_TO_CHARITY"
    },
    "redemptionRuleStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "description": "The charity you choose would get 1 cent per point for the maximum points of 500,000 you donate in a calendar year.",
    "offsetRedeemablePoints": null,
    "loyaltyTierLevel": {
        "nickname": "None",
        "name": "NONE"
    },
    "merchantId": 1,
    "createdUserName": null,
    "message": {
        "code": "40",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "REDEMPTION_RULE_ENABLE_SUCCESS",
        "parameters": null
    }
}

Updated As Of Version 6.6.x