Create reward

post https://{host}/api_gateway/rewards/core/v1/reward/create

This API is used to create the 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 time zone.

There is no limit on the number of rewards you can create.

New brands should no longer use the "Intouch Points" field. Instead, they should only use the new "paymentConfig" block.

Prerequisites

Authentication: Basic or OAuth credentials
Default access group

Resource information


URI	/api_gateway/rewards/core/v1/reward/create
HTTP Method	POST
Pagination	No
Batch support	No
Rate limit information	None

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/reward/create

Request body parameters

Parameter Name	Data Type	Description
name	String	Identifier for the reward. Ex: Discount On Handbags
description	String	Description of the reward. Ex: 150 off on handbags and wallets. It can be null.
startTime*	DateTime	Start time of the reward. Ex: 2024-09-26T20:00:00. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ. (Start time and end time are in UTC time zone)
endTime*	DateTime	End time of the reward. Ex: 2026-09-26T20:00:00. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ. (Start time and end time are in UTC time zone)
priority	Integer	Brands can use Metadata for the reward for UI, auditing, or reporting purposes, and it can be left as null. The priority value must be a non-negative number and cannot be negative.
type*	Enum	Type of the reward. Supported values: POINTS, VOUCHER, PHYSICAL_VOUCHER, FREE_VOUCHER.
brandId*	String	Brand ID. You can use the API and retrieve the brand ID of your brand.
enabled	Boolean	Status of the reward.
intouchPoints*	Integer	The number of points customers need to burn to purchase the reward. Ex: 500. THis is optional if reward type is FREE_VOUCHER.
intouchSeriesId	String	Coupon series ID or cart promotion ID when intouch reward is selected. (Coupon should be active*). This mandatory when redemption type is INTOUCH_REWARD
tier	String	The tier level, e.g., "SILVER".
geography	Object	Geographic applicability, including countryId for restriction.
paymentConfigs	Object	The list of payment mode supported by the reward.
groupName	String	A label assigned to a set of rewards to organize them based on common themes or purposes.
paymentMode	Enum	The type of payment mode supported to redeem the reward. Supported values: POINTS, FREE, CASH, POINTS_CASH, CONV_RATIO. Multiple payments are not supported within FREE and CONV_RATIO modes. NOTE: The same payment method cannot be used twice to create a reward. For example, only the first entry will be considered if you use POINTS twice as a payment mode. For more information, refer to Supported payment modes.
groups	Array of objects	An array containing information about groups and rewards associated with reward.
groupRank	Integer	The priority level assigned to a reward group to determine its display order in the catalog.
rewardRank	Integer	The priority level assigned to an individual reward within a group to highlight its importance or relevance.
categories	Integers	Metadata for the reward to categorize different rewards in different categories for end users. It can be null.
redemptionType*	Enum	Type of intouch reward or vendor reward. Supported values: GAMES, AUCTION, CART_PROMOTION, CASH_WALLET, VENDOR_ONLY_REWARD, VOUCHER, CASH_BACK, INTOUCH_REWARD, PHYSICAL_REWARD, CHARITY, MILES, GIFT_CARD, SWEEPSTAKES, VENDOR_INTOUCH_REWARD, CARD_DISC. For validation of redemptiontype, refer to Reward Creation/Update Validations. Notes: 1. If redemptionType is MILES, Payment config is mandatory. 2. CONV_RATIO mode is supported only for CHARITY, MILES, CASH_WALLET, SWEEPSTAKES, AUCTION, GIFT_CARD, PHYSICAL_REWARD type of redemption types. 3. If redemptionType is FREE_VOUCHER and payment mode is set, no points will be deducted.
vendorRedemption	Object	Vendor redemption is the reward configured for a particular vendor.
communications	String	Communication IDs related to the reward.
restrictions	Object	Restrictions on the reward, detailed in customer and reward levels.
kpi	Enum	The KPI on which the reward is created. Supported values: Transaction Count, Quantity.
limit	Integer	The maximum number of rewards that can be created. n
repeatFrequencyType	Enum	The frequency of the reward. Supported values: DAYS, WEEKS, MONTHS.
supplementaryCriteriaRO	Object	Tier/supplementary programs for which the reward is being created.
loyaltyProgramId	Integer	Unique identifier of the loyalty program.
tierIds	Integer	Unique identifier of the tier.
partnerProgramIds	Integer	Unique identifier of the partner program.
customFields	Object	The 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.
languageSpecificInfo*	Object	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.
languageCode	String	The ISO code for the language. For ex: FR-French, JA- Japanese etc.
name	String	The name of the reward in the specified language.
description	String	A description of the reward in the specified language.
termNConditions	String	You 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. It can be null.
termNConditionsId	String	The identifier for terms and conditions. Uploading the termsNconditons file to the file service/solutions workspace generates this unique identifier.
imageId	String	The 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.
thumbnailId	String	The identifier for the thumbnail image.
enabled	Boolean	Indicates if the language should be enabled or not.
images	Object	A 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.
name	String	The name of the image. The name should be unique. Warning: If a name is passed twice, only the first one will be considered.
id	String	The file_handle of the image. Uploading the image to the file service/solutions workspace generates this unique identifier.
url	String	The URL of the image.
isExternal	Boolean	Indicates if the image is hosted an external server.
videos	Object	A 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.
name	String	The name of the video. The name should be unique. Warning: If a name is passed twice, only the first one will be considered.
id	String	The file_handle of the video. Uploading the video to the file service/solutions workspace generates this unique identifier.
url	String	The URL of the video.
isExternal	Boolean	Indicates if the video is hosted an external server.
customFields	Object	The 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.
customFieldName	String	Name of the custom field.
customFieldValue	String	Value of the custom field.
owners	Object	List containing detailed owner information
ownerType	Enum	The module for which the reward was created. Supported values: LOYALTY_PROGRAM, MILESTONES, CAMPAIGNS, JOURNEYS, GOODWILL.
ownerId	String	Unique identifier of the owner to claim the reward. Multiple owner IDs are supported for a single reward with the same owner type.
rewardRevenueMeta	Object	An object with commission details for different participants over specific periods.
commissionParticipant	Enum	The entity receiving the commission. Supported values: BRAND, CAPILLARY, AFFILIATE, END_CUSTOMER.
commissionRate	Float	The amount of commission to be received.
cycleStartDate	Date	Start date of the commission cycle. Note: - cycleStartDate should be greater than rewardStartDate. - cycleStartDate must be in the future
cycleEndDate	Date	End date of the commission cycle. Note: - cycleEndDate should smaller than rewardEndDate. - cycleEndDate must be in the future
rewardRevenueDefaults	Object	An object with the default commission. In case multiple blocks with the same commissionParticipant are passed, only the first is considered. For more information, refer to revenue metadata.
commissionParticipant	Enum	The entity receiving the commission. Supported values: BRAND, CAPILLARY, AFFILIATE, END_CUSTOMER
defaultValue	Float	Default commission rate associated with the participant. Note: If no defaultValue is passed, then 0 is considered as the defaultValue.
segment	Object	Customer Segmentation involves logically grouping audiences based on shared characteristics. You can create segments using the Insights+ UI. For more information on creating segments, refer to this guide. You can use these segments to create rewards targeting specific customer groups. Use Case: Suppose you have a customer segment based on transaction volume, categorized into High, Medium, and Low buckets. If you want to offer rewards only to customers categorized as high-value transaction customers, you can use that specific customer segment and partition ID to tailor the rewards. For example, if a customer has 10,000 transactions in a month and falls into the top 3 transactions per month bucket, you can display only high-value rewards to them. The segment ID and partition ID are not currently available in the Insights+ UI. Note: The segments and partition information should be valid and the segments must be active while creating the reward.
segmentId	Integer	Enter the segment ID. The Segment ID is a unique identifier used to create or update segment information.
partitionId	Integer	Enter 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",
                  	"url": "www.qwrety.com"
                },
                {
                    "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": "2025-03-07T08:53:49.000Z",
    "endTime": "2026-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 Enabledsdqwerty",
            "description": "Description",
            "termNConditions": "ABC",
            "thumbnailId": "EXDR12987T",
            "imageId": "EXDR12987U",
            "enabled": true,
            "termNConditionsId": "EXDR12987R",
            "languageCode": "en",
             "customFields":{
                "mandatory - CF1": "englishvalue1"
            }
        },
        {
            "name": " INTOUCH Enabledsdoiu",
            "description": "Description",
           	"termNConditions": "ABCD",
            "thumbnailId": "EXDR12987T",
            "imageId": "EXDR12987U",
            "enabled": true,
            "termNConditionsId": "EXDR12987R",
            "languageCode": "fr",
             "customFields":{
                "mandatory - CF1": "frenchvalue1",
                "mandatory - CF2":"frenchvalue2"
            }
        }
    ],
    "customFields":{
        "mandatory - CF1": "rewardvalue1",
        "mandatory - CF2": "rewardvalue2"
    },
    "categories":
    [
        "11"
    ],
    "rewardRank":"1",        
    "redemptionType": "INTOUCH_REWARD",
    "communications":
    [
        "11"
    ],
    "vendorRedemption": null,
    "group": null,
    "label": null
}


{
    "startTime": "2025-03-07T17:04:30.000Z",
    "endTime": "2026-10-31T05:39:49.000Z",
    "rewardRevenueMeta" : [
        {
            "commissionParticipant": "BRAND",
            "commissionRate": "1.0",
            "cycleStartDate": "2025-03-07T17:04:30.000Z",
            "cycleEndDate": "2026-02-06T07:43:30.000Z"
        },
        {
            "commissionParticipant": "AFFILIATE",
            "commissionRate": "1.2",
            "cycleStartDate": "2025-03-07T17:04:30.000Z",
            "cycleEndDate": "2026-02-06T07:43:30.000Z"
        }
    ],
    "rewardRevenueDefaults": [
        {
            "commissionParticipant": "AFFILIATE",
            "defaultValue": "1.1"
        },
        {
            "commissionParticipant": "END_CUSTOMER",
            "defaultValue": "1.3"
        },
        {
            "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":"6134",
    "partitionId": ["2669"]
    },
    {
    "segmentId":"6136",
    "partitionId": ["2675"]
    }
  ]
}

{
    "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
}

{
    "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": 150
        },
        {
            "paymentMode": "CASH",
            "cash": 500
        },
        {
            "paymentMode": "POINTS_CASH",
          	"points": 200,
            "cash": 500
        },
    ],
    "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": "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": 150
        }
    ],
    "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": "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": "CASH",
            "cash": 300
        }
    ],
    "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": "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_CASH",
            "points": 300,
          	"cash": 200
        }
    ],
    "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": "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": "CONV_RATIO",
            "conversionRatio": 0.33
        }
    ],
    "categories": [
        4
    ],
    "rewardRank":"1",
    "intouchSeriesId": "301233",
    "redemptionType": "MILES",
    "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": "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": "FREE"
        }
    ],
    "categories": [
        4
    ],
    "rewardRank":"1",
    "intouchSeriesId": "301233",
    "redemptionType": "MILES",
    "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
}

Response parameters

Parameter Name	Data Type	Description
status	Object	Contains details about the status of the request
success	Boolean	Indicates whether the request was successful.
code	Integer	Status code associated with the response.
message	String	The descriptive message of the response,
reward	Object	Contains details about the reward created
id	Integer	Unique identifier for the created reward

{
    "status": {
        "success": true,
        "code": 6002,
        "message": "Reward created successfully"
    },
    "reward": {
        "id": 124158
    }
}

{
   "status": {
       "success": false,
       "code": 6003,
       "message": "Unable to create reward as Org doesn't have the custom field/s: CF0"
   },
   "reward": null
}

{
    "status": {
        "success": false,
        "code": 400,
        "message": "Conversion ratio can be set only for MILES, CASH_WALLET and CHARITY content types."
    }
}

{
    "status": {
        "success": false,
        "code": 400,
        "message": "Multiple payments is not supported within FREE and CONV_RATIO modes"
    }
}

{
    "status": {
        "success": false,
        "code": 6003,
        "message": "Unable to create reward as Invalid Segment Id:  6136"
    },
    "reward": null
}

{
    "status": {
        "success": false,
        "code": 400,
        "message": "Vendor redemption is required in case of Vendor rewards"
    }
}

{
    "status": {
        "success": false,
        "code": 400,
        "message": "Reward Term & Conditions can't be null or empty."
    }
}

Reward Creation/Update Validations

Redemption Type Validation:

If the redemptionType provided does not support vendor flow (i.e., when redemption is handled by an external vendor), the vendorRedemption field must be null.

Example:

{  
  "intouchSeriesId": "123",  
  "vendorRedemption": null,  
  "redemptionType": "CART_PROMOTION"  
}

If the redemptionType provided supports vendor flow (i.e., when redemption is handled by an external vendor), the intouchSeriesId field must be null.

Example:

{  
  "intouchSeriesId": null,  
  "vendorRedemption": 2000,  
  "redemptionType": "MILES"  
}

Redmeption Type-Specific Validation:

For the INTOUCH_REWARD redemption type, a numeric intouchSeriesId is mandatory.

Example:

{  
  "redemptionType": "INTOUCH_REWARD",  
  "intouchSeriesId": "6602d0937ea62412eec7b38d"  
}

For the CART_PROMOTION redemption type, an intouchSeriesId is mandatory.

Example:

{  
  "redemptionType": "CART_PROMOTION",  
  "intouchSeriesId": "6602d0937ea62412eec7b38d"  
}

For the VENDOR_INTOUCH_REWARD redemption type, both a numeric intouchSeriesId and a valid vendorRedemption are mandatory.

Example:

{  
  "redemptionType": "VENDOR_INTOUCH_REWARD",  
  "intouchSeriesId": "6602d0937ea62412eec7b38d",  
  "vendorRedemption": 2000  
}

Redemption Type cannot be changed:

Once a reward has been started, the redemption Type cannot be changed.

Using Existing Values When Updating:

When you're updating a reward, if you leave out any fields (like vendorRedemption or intouchSeriesId), the system will automatically keep the values from the existing reward. So, you only need to provide the fields you want to change—everything else stays the same as before.

API-specific error codes

Error code	Description
6003	- Reward creation failed due to the absence of a required custom field in the Org settings - Invalid segment ID

Language

Credentials

Basic

base64

URL

Click Try It! to start a request and see the response here!

👍Note

Prerequisites

Resource information

API endpoint example

Request body parameters

Response parameters

Reward Creation/Update Validations

Redemption Type Validation:

Redmeption Type-Specific Validation:

Redemption Type cannot be changed:

Using Existing Values When Updating:

API-specific error codes

👍
Note