Update Bonus Rule
1 min
PUT
https://api.b.preview.loyaltyservices.io/api/v3/bonus-rules/{code}
Path Parameters
- codestringrequiredDescription
Body Parameters
- bodyBonusRulerequiredDescription
- codestringExampleDescriptionMin Length1Max Length100
- externalCodestringExampleDescriptionMax Length100
- namestringExampleDescriptionMin Length1Max Length300
- typeCodestringExampleDescription
- enrollmentCodestringExampleDescription
- statusCodestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- campaignNamestringExampleDescription
- awardAutomaticallybooleanDescription
- displayOnlinebooleanExampleDescription
- displayOnlineUntilDatestring<date>ExampleDescriptionFormatdate
- minUserRoleCodestringExampleDescription
- contentKeystringExampleDescription
- clientTagstringExampleDescription
- workflowStatusstringExampleDescription
- rawExpressionstringDescription
- dataReleaseNamestringExampleDescriptionMax Length250
- commentsstringExampleDescriptionMax Length200
- limitsBonusRuleLimitsDescription
- occurrenceLimitinteger<int64>ExampleDescriptionFormatint64
- pointInstanceLimitnumberExampleDescription
- pointMinInstanceLimitinteger<int32>ExampleDescriptionFormatint32
- pointLimitnumberExampleDescription
- graceLimitinteger<int32>ExampleDescriptionFormatint32
- timePeriodOccurrenceLimitUnitTypestringExampleDescription
- timePeriodOccurrenceLimitinteger<int64>ExampleDescriptionFormatint64
- invoicingProBonusInvoicingDescription
- billablebooleanDescription
- billableToTypeCodestringExampleDescription
- invoiceTypeCodestringExampleDescription
- invoiceAmountnumberExampleDescription
- invoiceRatenumberExampleDescription
- ownerNamestringExampleDescription
- taxablebooleanDescription
- resultsProBonusResultsDescription
- pointCategoryCodestringExampleDescription
- resultTypeCodestringExampleDescription
- resultAmountnumberExampleDescription
- resultSubTypeCodestringExampleDescription
- tierQualifierbooleanDescriptionDefaultfalse
- counterTypeCodestringExampleDescription
- tierCodestringExampleDescription
- tierExpireDaysinteger<int32>ExampleDescriptionFormatint32
- tierExpireDatestring<date>ExampleDescriptionFormatdate
- tierPeriodsinteger<int32>ExampleDescriptionFormatint32
- futureTierCodestringExampleDescription
- futureTierExpireDaysinteger<int32>ExampleDescriptionFormatint32
- futureTierExpireDatestring<date>ExampleDescriptionFormatdate
- futureTierPeriodsinteger<int32>ExampleDescriptionFormatint32
- exactEndTierCodestringExampleDescription
- exactEndTierExpireDatestring<date>ExampleDescriptionFormatdate
- couponAwardNamestringExampleDescription
- badgeNamestringExampleDescription
- promotionRuleCodestringExampleDescription
- redemptionRuleCodestringExampleDescription
- redemptionQuantityinteger<int32>ExampleDescriptionFormatint32
- communicationKeystringExampleDescription
- segmentCodestringExampleDescription
- bonusRuleCodestringExampleDescription
- preventCancellationbooleanDescriptionDefaultfalse
- resultExternalCodestringExampleDescription
- countersProBonusResultCounter[]Description
- counterTypestringExampleDescription
- counterValuenumberExampleDescription
- counterResultTypestringExampleDescription
Responses
200
- BonusRule
- codestringExampleDescriptionMin Length1Max Length100
- externalCodestringExampleDescriptionMax Length100
- namestringExampleDescriptionMin Length1Max Length300
- typeCodestringExampleDescription
- enrollmentCodestringExampleDescription
- statusCodestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- campaignNamestringExampleDescription
- awardAutomaticallybooleanDescription
- displayOnlinebooleanExampleDescription
- displayOnlineUntilDatestring<date>ExampleDescriptionFormatdate
- minUserRoleCodestringExampleDescription
- contentKeystringExampleDescription
- clientTagstringExampleDescription
- workflowStatusstringExampleDescription
- rawExpressionstringDescription
- dataReleaseNamestringExampleDescriptionMax Length250
- dataReleaseItemStatusstringExampleDescriptionMax Length50
- commentsstringExampleDescriptionMax Length200
- limitsBonusRuleLimitsDescription
- occurrenceLimitinteger<int64>ExampleDescriptionFormatint64
- pointInstanceLimitnumberExampleDescription
- pointMinInstanceLimitinteger<int32>ExampleDescriptionFormatint32
- pointLimitnumberExampleDescription
- graceLimitinteger<int32>ExampleDescriptionFormatint32
- timePeriodOccurrenceLimitUnitTypestringExampleDescription
- timePeriodOccurrenceLimitinteger<int64>ExampleDescriptionFormatint64
- invoicingProBonusInvoicingDescription
- billablebooleanDescription
- billableToTypeCodestringExampleDescription
- invoiceTypeCodestringExampleDescription
- invoiceAmountnumberExampleDescription
- invoiceRatenumberExampleDescription
- ownerNamestringExampleDescription
- taxablebooleanDescription
- resultsProBonusResultsDescription
- pointCategoryCodestringExampleDescription
- resultTypeCodestringExampleDescription
- resultAmountnumberExampleDescription
- resultSubTypeCodestringExampleDescription
- tierQualifierbooleanDescriptionDefaultfalse
- counterTypeCodestringExampleDescription
- tierCodestringExampleDescription
- tierExpireDaysinteger<int32>ExampleDescriptionFormatint32
- tierExpireDatestring<date>ExampleDescriptionFormatdate
- tierPeriodsinteger<int32>ExampleDescriptionFormatint32
- futureTierCodestringExampleDescription
- futureTierExpireDaysinteger<int32>ExampleDescriptionFormatint32
- futureTierExpireDatestring<date>ExampleDescriptionFormatdate
- futureTierPeriodsinteger<int32>ExampleDescriptionFormatint32
- exactEndTierCodestringExampleDescription
- exactEndTierExpireDatestring<date>ExampleDescriptionFormatdate
- couponAwardNamestringExampleDescription
- badgeNamestringExampleDescription
- promotionRuleCodestringExampleDescription
- redemptionRuleCodestringExampleDescription
- redemptionQuantityinteger<int32>ExampleDescriptionFormatint32
- communicationKeystringExampleDescription
- segmentCodestringExampleDescription
- bonusRuleCodestringExampleDescription
- preventCancellationbooleanDescriptionDefaultfalse
- resultExternalCodestringExampleDescription
- countersProBonusResultCounter[]Description
- counterTypestringExampleDescription
- counterValuenumberExampleDescription
- counterResultTypestringExampleDescription
- allowedActionsRuleAllowedActionsDescription
- modifybooleanDescription
- managebooleanDescription
- adminbooleanDescription
- deletebooleanDescription
400
- ErrorResponse
- errorsValidationError[]Description
- codestringDescription
- fieldNamestringDescription
- messagestringDescription
- messageParametersobject[]Description
401
403
404
500
curl
curl --request PUT \
--url https://api.b.preview.loyaltyservices.io/api/v3/bonus-rules/{code} \
--header 'accept: application/json'ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.b.preview.loyaltyservices.io/api/v3/bonus-rules/{code}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/bonus-rules/{code}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://api.b.preview.loyaltyservices.io/api/v3/bonus-rules/{code}")
.method("PUT", body)
.addHeader("accept", "application/json")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();200
// Success
{
"code": "ENROLLMENT_BONUS_2026",
"externalCode": "EXT-12345",
"name": "Enrollment Bonus 2026",
"typeCode": "Enrollment",
"enrollmentCode": "ENROLL-2026-Q1",
"statusCode": "A",
"startDate": "2026-01-01",
"endDate": "2026-12-31",
"campaignName": "Q1 2026 Enrollment Campaign",
"awardAutomatically": false,
"displayOnline": true,
"displayOnlineUntilDate": "2026-12-31",
"minUserRoleCode": "Admin",
"contentKey": "promo-summer-2026",
"clientTag": "VIP",
"workflowStatus": "WORKING",
"rawExpression": "",
"dataReleaseName": "Rules Release 2025",
"dataReleaseItemStatus": "LIVE",
"comments": "Created for Q1 campaign",
"limits": {
"occurrenceLimit": 3,
"pointInstanceLimit": 1000,
"pointMinInstanceLimit": -5,
"pointLimit": 5000,
"graceLimit": 30,
"timePeriodOccurrenceLimitUnitType": "Day",
"timePeriodOccurrenceLimit": 5
},
"invoicing": {
"billable": false,
"billableToTypeCode": "Hotel",
"invoiceTypeCode": "Standard",
"invoiceAmount": 25,
"invoiceRate": 0.15,
"ownerName": "Marketing Team",
"taxable": false
},
"results": {
"pointCategoryCode": "Base",
"resultTypeCode": "Fixed",
"resultAmount": 500,
"resultSubTypeCode": "Base",
"tierQualifier": false,
"counterTypeCode": "Nights",
"tierCode": "GOLD",
"tierExpireDays": 90,
"tierExpireDate": "2026-12-31",
"tierPeriods": 2,
"futureTierCode": "PLATINUM",
"futureTierExpireDays": 90,
"futureTierExpireDate": "2027-12-31",
"futureTierPeriods": 2,
"exactEndTierCode": "SILVER",
"exactEndTierExpireDate": "2026-06-30",
"couponAwardName": "Welcome Award",
"badgeName": "Gold Status Badge",
"promotionRuleCode": "PROMO-2026-SUMMER",
"redemptionRuleCode": "FREE-NIGHT",
"redemptionQuantity": 1,
"communicationKey": "ENROLL_WELCOME",
"segmentCode": "VIP-SEGMENT",
"bonusRuleCode": "ENROLL-FOLLOW-UP",
"preventCancellation": false,
"resultExternalCode": "EXTERNAL_REWARD_CODE",
"counters": [
{
"counterType": "Nights",
"counterValue": 10,
"counterResultType": "Fixed"
}
]
},
"allowedActions": {
"modify": false,
"manage": false,
"admin": false,
"delete": false
}
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
404
// Not found
500
// Internal error