Update Reward

This API is used to update a particular reward.

๐Ÿ‘

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 .
  • Start time and end time are in UTC zone

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URI/api_gateway/rewards/core/v1/reward/{reward ID}/brand/{brand ID}
HTTP MethodPUT
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/reward/112295/brand/1

Request path parameters

Parameter NameData TypeDescription
brandId*StringBrand ID. You can use the API and retrieve the brand ID of your brand.
rewardId*StringUnique reward identidier.

Request body parameters

Parameter NameData TypeDescription
nameStringIdentifier for the reward. Ex: Discount On Handbags
descriptionStringDescription of the reward. Ex: 150 off on handbags and wallets
startTime*DateTimeStart time of the reward. Ex: 2024-09-26T20:00:00. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
endTime*DateTimeEnd time of the reward. Ex: 2026-09-26T20:00:00. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
priorityIntegerBrands can use Metadata for the reward for UI, auditing, or reporting purposes.
type*EnumType of the reward.
Supported values: POINTS, VOUCHER, PHYSICAL_VOUCHER, FREE_VOUCHER.
brandId*StringYou can use the API and retrieve the brand ID of your brand.
enabledBooleanStatus of the reward.
intouchPointsIntegerThe number of points customers need to burn to purchase the reward. Ex: 500
intouchSeriesIdStringCoupon series ID or cart promotion ID when intouch reward is selected.
tierStringThe tier level, e.g., "SILVER".
geographyObjectGeographic applicability, including countryId for restriction.
paymentConfigsObjectThe list of payment mode supported by the reward.
paymentModeEnumThe type of payment mode supported to redeem the reward. Supported values: POINTS, FREE, CASH, POINTS_CASH,CONV_RATIO.

For more information, refer to Supported payment modes.
groupNameStringA label assigned to a set of rewards to organize them based on common themes or purposes.
groupRankIntegerThe priority level assigned to a reward group to determine its display order in the catalog.
rewardRankIntegerThe priority level assigned to an individual reward within a group to highlight its importance or relevance.
categories*IntegersMetadata for the reward to categorize different rewards in different categories for end users.
redemptionType*EnumType of intouch reward or vendor reward.
Supported values: INTOUCH_REWARD, VENDOR_INTOUCH_REWARD, VENDOR_ONLY_REWARD, CART_PROMOTION,MILES, VOUCHER, POINTS, CHARITY, CASH_BACK,CASH_WALLET,CARD_DISC, GAMES.

Notes:

1. If redemptionType is MILES, Payment config is mandatory.
2. CONV_RATIO mode is supported only for CHARITY, MILES and CASH_WALLET type of redemption types.
3. If redemptionType is FREE_VOUCHER and payment mode is set, no points will be deducted.
vendorRedemptionObjectVendor redemption is the reward configured for a particular vendor.
communicationsStringCommunication IDs related to the reward.
restrictionsObjectRestrictions on the reward, detailed in customer and reward levels.
kpiEnumThe KPI on which the reward is created. Supported values: Transaction Count, Quantity.
limitIntegerThe maximum number of rewards to be created.
repeatFrequencyTypeEnumThe frequency of the reward. Supported values: DAYS, WEEKS, MONTHS.
supplementaryCriteriaROObjectTier/supplementary programs for which the reward is being created.
loyaltyProgramIdIntegerUnique identifier of the loyalty program.
tierIdsIntegerUnique identifier of the tier.
partnerProgramIdsIntegerUnique identifier of the partner program.
customFieldsObjectThe list of reward-level custom fields. Custom fields are columns that store custom information such as transaction details, customer details etc. These fields allow users to capture specific details that are not covered by standard fields. Users can define the properties of custom fields and assign default values.
languageSpecificInfoObject Enables the display of reward level information specified in this object in the desired language.
Note: There is no limit on the number of languages a user can define for custom fields
Prerequisite: If the desired language is not available in the system, raise a ticket to the Capillary support team to have it added.
languageCodeStringThe ISO code for the language. For ex: FR-French, JA- Japanese etc.
nameStringThe name of the reward in the specified language.
descriptionStringA description of the reward in the specified language.
termNConditionsStringYou can either pass the terms and conditions in text format or can enter the link to the file location where the terms and condition is present.
termNConditionsIdStringThe identifier for terms and conditions. Uploading the termsNconditons file to the file service/solutions workspace generates this unique identifier.
imageIdStringThe file_handle of the main image.
Uploading the image to the file service/solutions workspace generates this unique identifier. The main image is the image that the brand configures during the reward creation.
thumbnailIdStringThe identifier for the thumbnail image.
enabledBooleanIndicates if the language should be enabled or not.
imagesObjectA list of image details related to the reward.
Notes:

- A maximum of 10 images can be added to the reward. The brand can update the main image from these 10 images.
- You can use the ID or image URL to add the image.
nameStringThe name of the image. The name should be unique.
Warning: If a name is passed twice, only the first one will be considered.
idStringThe file_handle of the image. Uploading the image to the file service/solutions workspace generates this unique identifier.
urlStringThe URL of the image.
isExternalBooleanIndicates if the image is hosted an external server.
videosObjectA list of video details related to the reward.
Notes:

- A maximum of 10 images can be added to the reward. The brand can update the main image from these 10 images.
- You can use the ID or image URL to add the image.
nameStringThe name of the video. The name should be unique.
Warning: If a name is passed twice, only the first one will be considered.
idStringThe file_handle of the video.
Uploading the video to the file service/solutions workspace generates this unique identifier.
urlStringThe URL of the video.
isExternalBooleanIndicates if the video is hosted an external server.
customFieldsObjectThe list of custom fields. Custom fields are columns that store custom information such as transaction details, customer details etc. These fields allow users to capture specific details that are not covered by standard fields. Users can define the properties of custom fields and assign default values.

- If language-specific custom fields are unavailable, English values are used.
- If language-level custom fields are not defined, reward-level custom fields are used else, meta-level default values are used.
customFieldNameStringName of the custom field.
customFieldValueStringValue of the custom field.
ownersObjectList containing detailed owner information
ownerTypeEnumThe module for which the reward was created. Supported values: LOYALTY_PROGRAM, MILESTONES, CAMPAIGNS, JOURNEYS, GOODWILL.
ownerIdStringUnique identifier of the owner to claim the reward. Multiple owner IDs are supported for a single reward with the same owner type.
rewardRevenueMetaObjectAn object with commission details for different participants over specific periods.
commissionParticipantEnumThe entity receiving the commission.
Supported values: BRAND, CAPILLARY, AFFILIATE, END_CUSTOMER.
commissionRateFloatThe amount of commission to be received.
cycleStartDateDateStart date of the commission cycle.
Note:

- cycleStartDate should be greater than rewardStartDate.
- cycleStartDate must be in the future
cycleEndDateDateEnd date of the commission cycle.
Note:

- cycleEndDate should smaller than rewardEndDate.
- cycleEndDate must be in the future
rewardRevenueDefaultsObjectAn object with the default commission. In case multiple blocks with the same commissionParticipant are passed, only the first is considered.
commissionParticipantEnumThe entity receiving the commission.
Supported values: BRAND, CAPILLARY, AFFILIATE, END_CUSTOMER
defaultValueFloatDefault commission rate associated with the participant.
Note: If no defaultValue is passed, then 0 is considered as the defaultValue.
segmentObject Customer Segmentation is a logical grouping of audiences based on shared characteristics.
For example: Using segments, brands can categorize which rewards can be displayed for the customer. If a customer is enrolled in the silver tier the customer can only view rewards displayed for the silver tier.

You can create segments on Insights+ UI. For more information on creating segments refer here. The segment ID and partition ID are not currently available in the Insights+ UI. You can create the Jira ticket in order to get the segment and partition ID.

Note: The segments and partition information should be valid and the segments must be active while creating the reward.
segmentIdIntegerEnter the segment ID. The Segment ID is a unique identifier used to create or update segment information.
partitionIdIntegerEnter the partition ID. The Partition ID is a unique identifier used to create or update partition information.
{
    "name": "testreward1poi",
    "description": "testreward1",
    "startTime": "2025-09-26T20:00:00",
    "endTime": "2026-10-31T11:59:30",
    "priority": 1,
    "type": "VOUCHER",
    "brandId": "1",
    "enabled": true,
    "intouchPoints": 500,
    "geography": [
        {
            "countryId": 1
        }
    ],
    "categories": [
        4
    ],
    "rewardRank":"1",
    "intouchSeriesId": "301233",
    "redemptionType": "INTOUCH_REWARD",
    "vendorRedemption": null,
    "communications": [
        "1"
    ],
    "restrictions": {
        "customerLevel": [
            {
                "kpi": "QUANTITY",
                "limit": 10,
                "repeatFrequencyType": "DAYS",
                "interval": "30"
            },
            {
                "kpi": "QUANTITY",
                "limit": 50,
                "repeatFrequencyType": "MONTHS",
                "interval": "12"
            }
        ],
        "rewardLevel": [
            {
                "kpi": "QUANTITY",
                "limit": 10000,
                "repeatFrequencyType": "NO_LIMIT"
            }
        ]
    },
    "supplementaryCriteriaRO": [
        {
            "loyaltyProgramId": 469,
            "tierIds": null,
            "partnerProgramIds": [
                48
            ]
        },
        {
            "loyaltyProgramId": 690,
            "tierIds": null,
            "partnerProgramIds": null
        }
    ],
    "customFields": {
        "CF1": "Custom field 1"
    },
    "languageSpecificInfo": [
        {
            "languageCode": "en",
            "name": "testreward1",
            "description": "testreward1",
            "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
            "termNConditions": "t&c",
            "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
            "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
            "enabled": true
        }
    ],
    "isactive" : true
}
{
  	"name":"ABCD",
  	"description":"Reward",
    "startTime": "2025-02-06T07:43:30.000Z",
    "endTime": "2026-11-29T05:39:49.000Z",
    "type": "POINTS",
    "brandId": 3,
    "priority": 1,
    "enabled": true,
    "intouchPoints": 1,
    "intouchSeriesId": "6538e3ac60ce5c504144bb07",
    "tier": "SILVER",
    "geography": [
        {
            "countryId": 7
        }
    ],
    "languageSpecificInfo": [
        {
            "languageCode": "en",
            "name": " INTOUCH Enabled",
            "description": "Description",
            "termNConditionsId": "EXDR12987R",
            "imageId": "EXDR12987U",
            "thumbnailId": "EXDR12987T",
            "enabled": true,
            "images": [
                {
                    "name": "imagename1",
                    "id": "9b648b66-5700-4c6d-84ea-01ddf73927c6"
                },
                {
                    "name": "imagename2",
                    "id": "9b648b66-5700-4c6d-84ea-01ddf73927c6"
                },
                {
                    "name": "imagename2",
                    "id": "9b648b66-5700-4c6d-84ea-01ddf73927c6"
                }
            ],
            "videos": [
                {
                    "name": "videoname1",
                    "id": "9b648b66-5700-4c6d-84ea-01ddf73927c6",
                    "isExternal": false
                },
                {
                    "name": "videoname1",
                    "url": "https://www.youtube.com/watch?v=a_aSgmOqgrA",
                    "isExternal": true
                }
            ]
        }
    ],
    "categories": [
        5
    ],
    "redemptionType": "CART_PROMOTION",
    "communications": [
        4
    ],
    "owners": [
        {
            "ownerType": "LOYALTY_PROGRAM",
            "ownerId": "123"
        }
    ]
}
{
    "startTime": "2024-03-07T08:53:49.000Z",
    "endTime": "2024-03-14T05:39:49.000Z",
    "type": "POINTS",
    "brandId": "8",
    "priority": 1,
    "enabled": true,
    "intouchPoints": 3,
    "intouchSeriesId": "73684275",
    "tier": "GOLD",
    "geography":
    [
        {
            "countryId": "14"
        }
    ],
    "languageSpecificInfo":
    [
        {
            "name": " INTOUCH Enabledsd",
            "description": "Description",
            "termNConditions": "https://s3.amazonaws.com/crm-nightly-new-solutions/IRISV2BRAND/EXDR12987R?X-Amz-Security-Token=FwoGZXIvYXdzEAgaDImRT4Rv3I22aidrESLdAQJokVqNlcxpwvh%2FuileYhmM7vAPvlqLv4pA3icQ0z4opwko8bn2w1y2412RtCR1AXAhlB82T%2FT%2Fr4lMjSRbBy1i4lsWgIVWWQ00NMLW2TDumQcnFwQq1p%2BQFAofb1GS%2BcE4zoWTMieFVV3%2F15l2stJ7ZmwnyDYkDyqGzCk0AWoeQQw%2F%2BHu6DbeIcBJrEakvjZvLjqzeIACunRAYgrXAMlI5HfPenJl8CmEfvhgluUkUNQ25vrL6KhXEQKG4rdVjWG%2BxnkMgcZqBLth64qvfYES1wVyYz1OvneIhOdKbKO3tpZoGMi0%2F3wHyU2g0g7XXMM1cLRtUIn6x6%2BEzEdHMArLUdsCYy%2BnDOfaViZiRnhOtV6U%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20221014T145408Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNMI6TM5YP%2F20221014%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c17682bb64da475b6163148797a0c21dbb75fde352c2947fd94504d7f88535fe",
            "thumbnailId": "EXDR12987T",
            "imageId": "EXDR12987U",
            "enabled": true,
            "termNConditionsId": "EXDR12987R",
            "languageCode": "en",
             "customFields":{
               "mandatory - CF1": "englishvalue1"
               
            }
        },
        {
            "name": " INTOUCH Enabledsd",
            "description": "Description",
            "termNConditions": "https://s3.amazonaws.com/crm-nightly-new-solutions/IRISV2BRAND/EXDR12987R?X-Amz-Security-Token=FwoGZXIvYXdzEAgaDImRT4Rv3I22aidrESLdAQJokVqNlcxpwvh%2FuileYhmM7vAPvlqLv4pA3icQ0z4opwko8bn2w1y2412RtCR1AXAhlB82T%2FT%2Fr4lMjSRbBy1i4lsWgIVWWQ00NMLW2TDumQcnFwQq1p%2BQFAofb1GS%2BcE4zoWTMieFVV3%2F15l2stJ7ZmwnyDYkDyqGzCk0AWoeQQw%2F%2BHu6DbeIcBJrEakvjZvLjqzeIACunRAYgrXAMlI5HfPenJl8CmEfvhgluUkUNQ25vrL6KhXEQKG4rdVjWG%2BxnkMgcZqBLth64qvfYES1wVyYz1OvneIhOdKbKO3tpZoGMi0%2F3wHyU2g0g7XXMM1cLRtUIn6x6%2BEzEdHMArLUdsCYy%2BnDOfaViZiRnhOtV6U%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20221014T145408Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNMI6TM5YP%2F20221014%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c17682bb64da475b6163148797a0c21dbb75fde352c2947fd94504d7f88535fe",
            "thumbnailId": "EXDR12987T",
            "imageId": "EXDR12987U",
            "enabled": true,
            "termNConditionsId": "EXDR12987R",
            "languageCode": "fr",
            "customFields":{
               "non_mandatory-CF4":"frenchvalue4"
            }
        }
    ],
    "categories":
    [
        "11"
    ],
    "redemptionType": "INTOUCH_REWARD",
    "communications":
    [
        "11"
    ],
    "vendorRedemption": null,
    "group": null,
    "label": null
}

{
    "startTime": "2024-10-07T17:04:30.000Z",
    "endTime": "2027-10-31T05:39:49.000Z",
    "rewardRevenueMeta" : [
        {
            "commissionParticipant": "BRAND",
            "commissionRate": "1.5",
            "cycleStartDate": "2024-11-07T17:04:30.000Z",
            "cycleEndDate": "2025-10-06T07:43:30.000Z"
        },
        {
            "commissionParticipant": "AFFILIATE",
            "commissionRate": "1.2",
            "cycleStartDate": "2024-11-07T17:04:30.000Z",
            "cycleEndDate": "2026-10-06T07:43:30.000Z"
        }
    ],
    "rewardRevenueDefaults": [
        {
            "commissionParticipant": "AFFILIATE",
            "defaultValue": "1.1"
        },
        {
            "commissionParticipant": "END_CUSTOMER",
            "defaultValue": "1.3"
        }
    ],
      "type": "VOUCHER",
  "brandId": 3,
  "priority": 1,
  "enabled": true,
  "intouchPoints": 1,
  "intouchSeriesId": "1135336",
  "tier": "SILVER",
  "geography": [
    {
      "countryId": 7
    }
  ],
  "languageSpecificInfo": [
    {
      "languageCode": "en",
      "name": " INTOUCH Enabled",
      "description": "Description",
      "termNConditionsId": "EXDR12987R",
      "imageId": "EXDR12987U",
      "thumbnailId": "EXDR12987T",
      "enabled": true
    }
  ],
  "categories": [
    5
  ],
  "redemptionType": "INTOUCH_REWARD",
  "communications": [
    4
  ],
  "owners":[{
      "ownerType":"LOYALTY_PROGRAM",
      "ownerId":"123"
      }
  ]
}
{
    "name": "testreward1poitu",
    "description": "testreward11",
    "startTime": "2025-09-26T20:00:00",
    "endTime": "2026-10-31T11:59:30",
    "priority": 1,
    "type": "VOUCHER",
    "brandId": "1",
    "enabled": true,
    "intouchPoints": 500,
    "geography": [
        {
            "countryId": 1
        }
    ],
"paymentConfigs": [
       {
            "paymentMode": "POINTS",
            "points":100
        }
    ],
    "categories": [
        4
    ],
    "rewardRank":"1",
    "intouchSeriesId": "301233",
    "redemptionType": "INTOUCH_REWARD",
    "vendorRedemption": null,
    "communications": [
        "1"
    ],
    "restrictions": {
        "customerLevel": [
            {
                "kpi": "QUANTITY",
                "limit": 10,
                "repeatFrequencyType": "DAYS",
                "interval": "30"
            },
            {
                "kpi": "QUANTITY",
                "limit": 50,
                "repeatFrequencyType": "MONTHS",
                "interval": "12"
            }
        ],
        "rewardLevel": [
            {
                "kpi": "QUANTITY",
                "limit": 10000,
                "repeatFrequencyType": "NO_LIMIT"
            }
        ]
    },
    "supplementaryCriteriaRO": [
        {
            "loyaltyProgramId": 469,
            "tierIds": null,
            "partnerProgramIds": [
                48
            ]
        },
        {
            "loyaltyProgramId": 690,
            "tierIds": null,
            "partnerProgramIds": null
        }
    ],
    "customFields": {
        "CF1": "Custom field 1"
    },
    
    "languageSpecificInfo": [
        {
            "languageCode": "en",
            "name": "testreward1",
            "description": "testreward1",
            "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
            "termNConditions": "t&c",
            "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
            "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
            "enabled": true
        }
    ],
    "isactive" : true
}
{
    "startTime": "1817395653000",
    "endTime": "1910179714000",
    "type": "FREE_VOUCHER",
    "brandId": 3,
    "priority": 1,
    "enabled": true,
    "intouchPoints": 0,
    "intouchSeriesId": "1137472",
    "tier": "SILVER",
    "geography": [
        {
            "countryId": 7
        }
    ],
    "languageSpecificInfo": [
        {
            "languageCode": "en",
            "name": " English",
            "description": "Description",
            "termNConditionsId": "EXDR12987R",
            "imageId": "EXDR12987U",
            "thumbnailId": "EXDR12987T",
            "enabled": true
        }
    ],
    "categories": [
        5
    ],
    "redemptionType": "INTOUCH_REWARD",
    "communications": [
        4
    ],
    "segment": [
        
        {
            "segmentId": "6136",
            "partitionId": [
                "2675"
            ]
        }
    ]
}
{
    "id": 201374,
    "name": "testname",
    "description": "testname1",
    "startTime": "2024-07-17T11:00:00.000Z",
    "endTime": "2025-07-11T14:43:00.000Z",
    "priority": 1,
    "groups" : [
        {
            "groupName":"groupName012",
            "groupRank": 8
        },
        {
            "groupName":"groupName013"
            // "groupRank": 6
        }
    ],
    "type": "VOUCHER",
    "brandId": "1",
    "enabled": true,
    "intouchPoints": 500,
    "geography": [
        {
            "countryId": 1
        }
    ],

"paymentConfigs": [
       {
            "paymentMode": "POINTS",
            "points":100
        }
    ],

    "categories": [
        4
    ],
    "rewardRank":"1",
    "intouchSeriesId": "350219",
    "redemptionType": "INTOUCH_REWARD",
    "vendorRedemption": null,
    "communications": [
        "1"
    ],
    "restrictions": {
        "customerLevel": [
            {
                "kpi": "QUANTITY",
                "limit": 10,
                "repeatFrequencyType": "DAYS",
                "interval": "30"
            },
            {
                "kpi": "QUANTITY",
                "limit": 50,
                "repeatFrequencyType": "MONTHS",
                "interval": "12"
            }
        ],
        "rewardLevel": [
            {
                "kpi": "QUANTITY",
                "limit": 10000,
                "repeatFrequencyType": "NO_LIMIT"
            }
        ]
    },
 
    "customFields": {
        "CF1": "Custom field 1"
    },
    "languageSpecificInfo": [
        {
            "languageCode": "en",
            "name": "testreward1",
            "description": "testreward1",
            "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
            "termNConditions": "t&c",
            "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
            "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
            "enabled": true
        }
    ],
    "isactive" : true
}

Response parameters

Parameter NameData TypeDescription
statusObjectContains details about the status of the request
successBooleanIndicates the success of the request, true in this case
codeIntegerStatus code associated with the response, 6006
messageStringDescriptive message, "Reward updated successfully"
rewardObjectContains details about the reward
idIntegerUnique identifier for the updated reward, 90819
{
    "status": {
        "success": true,
        "code": 6006,
        "message": "Reward updated successfully"
    },
    "reward": {
        "id": 90819
    }
}

API-specific error codes

Error codeDescription
3014Unable to update reward as Org doesn't have the custom field/s: labels,tag
400Passed loyalty programId is not exists
400Passed entityId is not exists
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!