put https://{host}/api_gateway/v1/badges/badgeMeta
This API allows you to update badges.
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 .:
Attention
You cannot claim a badge during badge creation or updation.
Badge name should be unique and is case sensitive.
Prerequisites
- Authentication: Basic authentication
- Default access group
Resource information
| URI | /api_gateway/v1/badges/badgeMeta |
| HTTP method | PUT |
| Pagination | NA |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta
Request body parameters
| Field Name | Data Type | Description |
|---|---|---|
| id | String | Unique badge meta ID generated during creation of the badge. Note: It is mandatory to pass the badge meta ID to update the badge. |
| name* | String | Name of the badge. Ex: 10% off on watches. Badge name should be unique and is case sensitive. |
| description | String | Brief description of the badge. Ex: Purchase 2 watches get a $100 voucher. |
| startOn* | Date Time | Timestamp indicating when the badge starts. Timestamp in epoch time. |
| expiresOn* | Date Time | Timestamp indicating when the badge ends. Timestamp in epoch time. |
| earnedBadgeExpiry* | Object | Object containing details about the expiry of earned badges. |
| expiryType* | Enum | Type of badge expiry. Supported values: "RELATIVE","ABSOLUTE","NEVER" Relative expiry: Based on when the badge was issued. Absolute expiry: Based on the fixed date from the badge issual. Never: The badges will never expire after issual. |
| type* | Enum | Type refers to the badge expiration method based on fixed date or badge_meta. Supported values: WITH_BADGE_META, FIXED_DATE 1. WITH_BADGE_META: The expiry of the badge is based on the mandatory expiresOn parameter.2. FIXED_DATE: The expiry of the badge is based on the expiry date of the incentives associated with the badge. |
| expiresOn | Date | Timestamp indicating when the badge expires. It is mandatory to pass this expiresOn parameter when FIXED_DATE is chosen. |
| expireWithBadgeMeta* | Boolean | Indicates if the badge should expire based on the mandatory parameter expiresOn . |
| relativeExpiryType | Enum | Expiry type relative to the badge issue. Supprted values:DAYS/WEEKS/MONTHS. Applicable when expiryType is RELATIVE. |
| ownership* | Object | An object containing ownership restrictions. You cannot remove an owner if it has an active badge claim associated with it. For example, you cannot remove Loyalty as the owner if there is an active badge associated with it. |
| restrictedToOwners* | Object | List of owner categories that are allowed to claim the badge. |
| customerConstraints | Array | List of constraints specific to customers. This is applicable when earnType is EARN |
| constraintType | Enum | Type of customer constraint. Customer constraints are the restrictions applied by the brands to have control on the issuals of badges to a particular customer. Supported values: "CUSTOMER_BADGE_FIXED_WINDOW" , "CUSTOMER_BADGE_FIXED_VALUE", "CUSTOMER_BADGE_ROLLING_WINDOW" and "CUSTOMER_BADGE_NO_LIMIT". CUSTOMER_BADGE_FIXED_WINDOW: Refers to the fixed earn limit for the customer. In this constraint type, the system creates fixed windows based on the duration type chosen, during this time frame the customer can earn the badge. CUSTOMER_BADGE_ROLLING_WINDOW refers to the customer's earning limit calculated over a certain period in the past day/week/month. |
| durationType | Enum | Duration of the badge constraint. Supported values: DAILY, WEEKLY, MONTHLY. If durationType is set to Daily, refreshRate is a mandatory parameter. The system will create daily windows for the duration of the promotion. If durationType is set to Weekly, startDayOfTheWeek becomes a mandatory parameter, default value: Monday. For weekly, the system creates cycles as per the logic given below: - Badge start date - 25 Sep - Badge end date - 30 Oct - Limit cycles will be 25 Sep - 1 Oct, 2 Oct - 8 Oct, 9 Oct - 15 Oct. So on till 30 Oct. |
| refreshRate | Integer | Refers to the number of days the fixed window duration is. |
| startDayOfTheWeek | Enum | Day on which the cycle starts. Supported values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. |
| maxEarnLimit | Integer | The maximum limit a customer can earn during the week. |
| maxEarnForDays | Integer | Maximum earning limit per day This is applicable for CUSTOMER_BADGE_ROLLING_WINDOW. |
| rollForDays | Integer | The number of days for rolling calculation. Applicable only when CUSTOMER_BADGE_ROLLING_WINDOW is opted. |
| maxEarnForWeeks | Integer | Maximum earning limit per week. Applicable only when CUSTOMER_BADGE_ROLLING_WINDOW is opted. |
| rollForWeeks | Integer | Number of weeks for rolling calculation. Applicable only when CUSTOMER_BADGE_ROLLING_WINDOW is opted. |
| maxEarnForMonths | Integer | Maximum earning limit per month. Applicable only when CUSTOMER_BADGE_ROLLING_WINDOW is opted. |
| rollForMonths | Integer | Number of months for rolling calculation. Applicable only when CUSTOMER_BADGE_ROLLING_WINDOW is opted. |
| badgeConstraints | Array | Restrictions that are applied on the badge. This is applicable when issue type is EARN. |
| constraintType | Enum | Type of badge constraint. Badge constraints are the restrictions applied by the brands on the badges to create a limit the overall badges that can be issued to customer. Supported values: "BADGE_FIXED_WINDOW", "BADGE_ROLLING_WINDOW", "BADGE_FIXED_VALUE","BADGE_NO_LIMIT". BADGE_FIXED_WINDOW refers to the fixed earn limit of the badge. The system will create fixed windows based on the duration type chosen. BADGE_ROLLING_WINDOW refers to the badge earn limit calculated over a certain period in the past day/week/month. |
| durationType | Enum | Duration of the badge constraint. Supported values: DAILY, WEEKLY, MONTHLY. If durationType is set to Daily, refreshRate is a mandatory parameter. The system will create daily windows for the duration of the promotion. If durationType is set to Weekly, startDayOfTheWeek becomes a mandatory parameter, default value: Monday. For weekly, the system will create cycles as per the logic given below: - Badge start date - 25 Sep - Badge end date - 30 Oct - Limit cycles will be 25 Sep - 1 Oct, 2 Oct - 8 Oct, 9 Oct - 15 Oct. So on till 30 Oct. |
| refreshRate | Integer | Refers to the number of days the fixed window duration is. |
| startDayOfTheWeek | Enum | Day on which the cycle starts. Supported values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. |
| maxEarnLimit | Integer | The maximum limit a customer can earn during the period. |
| rollType | Enum | Timeframe of the rolling window. Supprted values:DAYS/WEEKS/MONTHS |
| rollValue | Integer | Value for rolling window calculation. |
| maxEarnLimit | Integer | Maximum limit a badge can earn. |
| earnType* | Enum | The method the brand can issue the badge. Supported values: EARN, ISSUE EARN. Earn: The selected customers are enrolled for the badge and upon fulfillment of the earn condition, the badge is issued. Issue Earn: The Badges are issued directly to the customer who fulfills the earn condition (no enrolment to badges-related program). Note: If the earnType is ISSUE_EARN, use the request body, Issue Earn Type tab below. |
| benefits | Array | List of benefits associated with the badge. |
| benefitType | Enum | Type of benefit linked to the badge. Supported values: COUPON, LOYALTY_POINTS, |
| seriesId | Integer | Series ID for the benefit. This is applicable for COUPON benefits. |
| points | Integer | Loyalty points associated with the benefit. This is applicable for LOYALTY_POINTS benefits. |
| programId* | Integer | Program ID for loyalty points This is applicable for LOYALTY_POINTS benefits. |
| promotionId* | Integer | Promotion ID for loyalty points This is applicable for LOYALTY_POINTS benefits. |
| allocationStrategyId* | Integer | Allocation strategy ID. Points allocation allows you to award points to customers based on certain activities. This is applicable for LOYALTY_POINTS benefits. |
| expirationStrategyId* | Integer | Expiration strategy ID. This is applicable for LOYALTY_POINTS benefits. |
| tags | Array | List of tags associated with the badge. |
| name | String | Name of the tag. |
| value | String | Value of the tag. |
| active* | Boolean | Indicates whether the badge is currently active. |
| customFields | Object | List of custom fields. |
| customFieldName | String | Name of the custom field |
| customFieldValue | String | Value of the custom field. |
| badgeGroupId | String | Unique group ID associated with the badge. To add the badge to a group, pass badgeGroupId value. |
| badgeRank | Integer | Badge rank is the rank of a badge within a group, the user can define the badge rank even if the group is not linked with the badge. |
Fixed window validation
- You can change the constraintType, maxEarnLimit, durationType, refreshRate, startDayOfTheWeek until the badge is live.
- Once the badge is live,
- You cannot change constraintType from fixed window to rolling window.
- You cannot change constraintType from rolling window to fixed window.
- You cannot change constraintType from fixed window to fixed value.
- You cannot change constraintType from fixed value to fixed window.
- You can change constraintType from rolling window fixed value.
- You can change constraintType from fixed value to rolling window.
{
"id": "8",
"orgId": 100606,
"name": "EARN-TYPE",
"description": "Purchase 5 pet products in 3 months and get a pet grooming voucher",
"startOn": 1799632870.000000000,
"expiresOn": 1828754110.000000000,
"earnedBadgeExpiry": {
"expiryType": "ABSOLUTE",
"type": "WITH_BADGE_META",
"expiresOn": null,
"expireWithBadgeMeta": true
},
"issuedBadgeExpiry": null,
"images": [],
"ownership": {
"restrictedToOwners": [
"Audience_Campaigns",
"Loyalty",
"Milestones"
],
"claims": []
},
"customerConstraints": [
{
"constraintType": "CUSTOMER_BADGE_FIXED_VALUE",
"maxEarnLimit": 100
},
{
"constraintType": "CUSTOMER_BADGE_ROLLING_WINDOW",
"maxEarnForDays": 1,
"rollForDays": 1,
"maxEarnForWeeks": 2,
"rollForWeeks": 1,
"maxEarnForMonths": 10,
"rollForMonths": 1
}
],
"badgeConstraints": [
{
"constraintType": "BADGE_FIXED_VALUE",
"maxEarnLimit": 1000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "DAYS",
"rollValue": 1,
"maxEarnLimit": 100
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "MONTHS",
"rollValue": 1,
"maxEarnLimit": 10000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "WEEKS",
"rollValue": 1,
"maxEarnLimit": 2000
}
],
"benefits": [
{
"benefitType": "COUPON",
"seriesId": 6789
},
{
"benefitType": "COUPON",
"seriesId": 13686
},
{
"benefitType": "LOYALTY_POINTS",
"programId": 626,
"promotionId": 80332,
"allocationStrategyId": 1489,
"expirationStrategyId": 3843,
"defaultTillId": null
},
{
"benefitType": "COUPON",
"seriesId": 1234
}
],
"tags": [],
"badgeGroupId": null,
"badgeRank": 1,
"earnType": "EARN",
"issuedCount": 0,
"earnedCount": 0,
"status": "UPCOMING",
"createdOn": 1707897126.091000000,
"createdBy": 75097962,
"lastUpdatedOn": 1707897126.091000000,
"lastUpdatedBy": 75097962,
"active": false
}
{
"id": "661e11563753c37878a8b2c7",
"orgId": 100606,
"name": "This is a badge",
"description": "Purchase products worth minimum 1K in the month of March and get this badge",
"startOn": 1808338345.000000000,
"expiresOn": 1828754110.000000000,
"earnedBadgeExpiry": {
"expiryType": "ABSOLUTE",
"type": "FIXED_DATE",
"expiresOn": 1828754110.000000000,
"expireWithBadgeMeta": false
},
"issuedBadgeExpiry": null,
"images": [],
"ownership": {
"restrictedToOwners": [
"Loyalty"
],
"claims": []
},
"customerConstraints": [
{
"constraintType": "CUSTOMER_BADGE_FIXED_WINDOW",
"referenceId": "e6791ec9-e92f-34af-bdc3-be2607fdf82c",
"durationType": "DAYS",
"refreshRate": 5,
"maxEarnLimit": 1,
"cycleStatus": "UPCOMING",
"startDate": 1808338345.000000000,
"endDate": 1828754110.000000000
}
],
/* "customerConstraints": [
{
"constraintType": "CUSTOMER_BADGE_ROLLING_WINDOW",
"maxEarnForDays": 50,
"rollForDays": 5,
"maxEarnForWeeks": 100,
"rollForWeeks": 1,
"maxEarnForMonths": 200,
"rollForMonths": 1
},
{
"constraintType": "CUSTOMER_BADGE_FIXED_VALUE",
"maxEarnLimit": 5000
}
],*/
"badgeConstraints": [
{
"constraintType": "BADGE_FIXED_VALUE",
"maxEarnLimit": 1000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "DAYS",
"rollValue": 1,
"maxEarnLimit": 100
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "WEEKS",
"rollValue": 1,
"maxEarnLimit": 2000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "MONTHS",
"rollValue": 1,
"maxEarnLimit": 10000
}
],
"benefits": [
{
"benefitType": "COUPON",
"seriesId": 13686
},
{
"benefitType": "LOYALTY_POINTS",
"programId": 626,
"promotionId": 80332,
"allocationStrategyId": 1489,
"expirationStrategyId": 3843,
"defaultTillId": null
}
],
"tags": [],
"badgeGroupId": null,
"badgeRank": null,
"earnType": "EARN",
"status": "UPCOMING",
"createdOn": 1713246550.885000000,
"createdBy": 75097962,
"lastUpdatedOn": 1713246550.885000000,
"lastUpdatedBy": 75097962,
"customFields": {
},
"active": true
}
Response parameters
| Parameter | Data Type | Description |
|---|---|---|
| data | Object | The main container for the response data. |
| id | String | Unique identifier for the badge. |
| orgId | Integer | Identifier for the organization associated with the badge. |
| name | String | Name of the badge. |
| description | String | Description of the bdage. |
| startOn | Float | Timestamp for when the badge starts. |
| expiresOn | Float | Timestamp for when the badge expires. |
| earnedBadgeExpiry | Object | Details about the expiry of the earned badge. |
| expiryType | String | Type of expiry for the earned badge. |
| type | String | Type of badge expiry. |
| expiresOn | Float | Timestamp for when the earned badge expires. |
| issuedBadgeExpiry | Object | Details about the expiry of the issued badge (null in this case). |
| images | Array of Objects | Array of images related to the item. |
| name | String | Name of the image. |
| fileSvcHandle | String | Service handle for the image file. |
| url | String | URL of the image. |
| tag | String | Tag associated with the image. |
| ownership | Object | Details about the ownership of the item. |
| restrictedToOwners | Array of Strings | Array of owner types who have restricted access. |
| customerConstraints | Array | Limit on how many badges can be issued to a particular customer. |
| badgeConstraints | Array | Limit on how many quantities of a reward can be given to customers |
| benefits | Array of Objects | Array of benefits associated with the item. |
| benefitType | String | Type of benefit. |
| seriesId | Integer | Identifier for the series of the benefit. |
| tags | Array | Custom metadata tagged to the reward used for auditing and reporting purposes |
| badgeGroupId | String | Group ID for the badge. |
| badgeRank | Integer | Badge rank is the rank within a group, user can define the badge rank even if group is not linked with the badge |
| earnType | String | The method the brand can issue the badge. Supported values: EARN, ISSUE EARN. Earn: The selected customers are enrolled for the badge and upon fulfillment of the earn condition, the badge is issued. Issue Earn: The Badges are issued directly to the customer who fulfills the earn condition. |
| issuedCount | Integer | Count of how many times the badge has been issued. |
| earnedCount | Integer | Count of how many times the badge has been earned. |
| status | String | The badge can have three statuses upon creation. Supported values: LIVE, UPCOMING, ENDED/EXPIRED. LIVE: The badges which are in live state and can be earned. UPCOMING: The badges which are upcoming on a further date. EXPIRED/ENDED: The badges which have expired and cannot be earned. |
| createdOn | Float | Timestamp for when the badgewas created. |
| createdBy | Integer | Identifier of the user who created the badge. |
| lastUpdatedOn | Float | Timestamp for the last update made to the badge. |
| lastUpdatedBy | Integer | Identifier of the user who last updated the badge. |
| customFields | Object | List of custom fields. |
| customFieldName | String | Name of the custom field. |
| customFieldValue | String | Value of the custom field. |
| active | Boolean | Indicates whether the badge is active or not. |
| errors | Null | Contains details of any error. |
| warnings | Null | Contains details of any warning. |
{
"data": {
"id": "8",
"orgId": 100606,
"name": "EARN-TYPE",
"description": "Purchase 5 pet products in 3 months and get a pet grooming voucher",
"startOn": 1799632870.000000000,
"expiresOn": 1828754110.000000000,
"earnedBadgeExpiry": {
"expiryType": "ABSOLUTE",
"type": "WITH_BADGE_META",
"expiresOn": null,
"expireWithBadgeMeta": true
},
"issuedBadgeExpiry": null,
"images": [],
"ownership": {
"restrictedToOwners": [
"Audience_Campaigns",
"Milestones",
"Loyalty"
],
"claims": []
},
"customerConstraints": [
{
"constraintType": "CUSTOMER_BADGE_FIXED_VALUE",
"maxEarnLimit": 100
},
{
"constraintType": "CUSTOMER_BADGE_ROLLING_WINDOW",
"maxEarnForDays": 1,
"rollForDays": 1,
"maxEarnForWeeks": 2,
"rollForWeeks": 1,
"maxEarnForMonths": 10,
"rollForMonths": 1
}
],
"badgeConstraints": [
{
"constraintType": "BADGE_FIXED_VALUE",
"maxEarnLimit": 1000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "WEEKS",
"rollValue": 1,
"maxEarnLimit": 2000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "MONTHS",
"rollValue": 1,
"maxEarnLimit": 10000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "DAYS",
"rollValue": 1,
"maxEarnLimit": 100
}
],
"benefits": [
{
"benefitType": "COUPON",
"seriesId": 6789
},
{
"benefitType": "COUPON",
"seriesId": 13686
},
{
"benefitType": "LOYALTY_POINTS",
"programId": 626,
"promotionId": 80332,
"allocationStrategyId": 1489,
"expirationStrategyId": 3843,
"defaultTillId": null
},
{
"benefitType": "COUPON",
"seriesId": 1234
}
],
"tags": [],
"badgeGroupId": null,
"badgeRank": 1,
"earnType": "EARN",
"status": "UPCOMING",
"createdOn": 1707897126.091000000,
"createdBy": 75097962,
"lastUpdatedOn": 1713852683.788076000,
"lastUpdatedBy": 75097962,
"customFields": {},
"active": false
},
"errors": [],
"warnings": []
}
{
"data": {
"id": "661e11563753c37878a8b2c7",
"orgId": 100606,
"name": "This is a badge",
"description": "Purchase products worth minimum 1K in the month of March and get this badge",
"startOn": 1808338345.000000000,
"expiresOn": 1828754110.000000000,
"earnedBadgeExpiry": {
"expiryType": "ABSOLUTE",
"type": "FIXED_DATE",
"expiresOn": 1828754110.000000000,
"expireWithBadgeMeta": false
},
"issuedBadgeExpiry": null,
"images": [],
"ownership": {
"restrictedToOwners": [
"Loyalty"
],
"claims": []
},
"customerConstraints": [
{
"constraintType": "CUSTOMER_BADGE_FIXED_WINDOW",
"referenceId": "1c11e757-4f00-3bb2-8aa0-b34e25083bb3",
"durationType": "DAYS",
"refreshRate": 5,
"maxEarnLimit": 1,
"cycleStatus": "UPCOMING",
"startDate": 1808338345.000000000,
"endDate": 1828754110.000000000
}
],
"badgeConstraints": [
{
"constraintType": "BADGE_FIXED_VALUE",
"maxEarnLimit": 1000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "WEEKS",
"rollValue": 1,
"maxEarnLimit": 2000
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "DAYS",
"rollValue": 1,
"maxEarnLimit": 100
},
{
"constraintType": "BADGE_ROLLING_WINDOW",
"rollType": "MONTHS",
"rollValue": 1,
"maxEarnLimit": 10000
}
],
"benefits": [
{
"benefitType": "COUPON",
"seriesId": 13686
},
{
"benefitType": "LOYALTY_POINTS",
"programId": 626,
"promotionId": 80332,
"allocationStrategyId": 1489,
"expirationStrategyId": 3843,
"defaultTillId": null
}
],
"tags": [],
"badgeGroupId": null,
"badgeRank": null,
"earnType": "EARN",
"status": "UPCOMING",
"createdOn": 1713246550.885000000,
"createdBy": 75097962,
"lastUpdatedOn": 1713955758.488460000,
"lastUpdatedBy": 75097962,
"customFields": {},
"active": true
},
"errors": [],
"warnings": []
}
API-specific error codes
| Error code | Description |
|---|---|
| 400 | Invalid enum value |
| 720 | Start Date should be before End Date |
| 723 | Start Date cannot change once the badge is live |
| 826 | Change from rolling window or fixed constraint to fixed window or vice versa is not allowed. |